Home Reference Source
import {PipingDefaultParameter} from '@fnndsc/chrisapi'
public class | source

PipingDefaultParameter

Extends:

ResourceItemResource → PipingDefaultParameter

Item resource object for a plugin piping default parameter which represents a default value for a plugin parameter associated with the corresponding plugin piping.

Method Summary

Public Methods
public

Fetch the corresponding plugin parameter for this plugin piping default parameter from the REST API.

public

Fetch the corresponding plugin piping for this plugin piping default parameter from the REST API.

Inherited Summary

From class Resource
public static

cloneObj(obj: Object): *

Helper method to make a deep copy clone of the passed object resource.

public get

Return true if the resource object contains any data.

public
public
public
public
public

Make a deep copy clone of this object resource.

From class ItemResource
public get

Get the item's data object (REST API descriptors).

public
public

get(timeout: number): Promise<this>

Fetch this item resource from the REST API.

public

Get an array of parameter names that can be used as properties of the data object in PUT requests.

private

_delete(timeout: number): Promise

Internal helper method to make a DELETE request to this item resource through the REST API.

private

_getResource(linkRelation: string, ResourceClass: Object, searchParams: Object, timeout: number): Promise<ResourceClass>

Internal method to fetch a related resource from the REST API that is referenced by a link relation within the item object.

private

_put(data: Object, uploadFileObj: Object, timeout: number): Promise<this>

Internal helper method to make a PUT request to this item resource through the REST API.

Public Methods

public getPluginParameter(timeout: number): Promise<PluginParameter> source

Fetch the corresponding plugin parameter for this plugin piping default parameter from the REST API.

Params:

NameTypeAttributeDescription
timeout number
  • optional
  • default: 30000

request timeout

Return:

Promise<PluginParameter>

JS Promise, resolves to a PluginParameter object

public getPluginPiping(timeout: number): Promise<PluginPiping> source

Fetch the corresponding plugin piping for this plugin piping default parameter from the REST API.

Params:

NameTypeAttributeDescription
timeout number
  • optional
  • default: 30000

request timeout

Return:

Promise<PluginPiping>

JS Promise, resolves to a PluginPiping object