import {PipelineList} from '@fnndsc/chrisstoreapi'

public class | source

PipelineList

Extends:

Resource → ListResource → PipelineList

Pipeline list resource object representing a list of pipelines.

Constructor Summary

Public Constructor
public	constructor(url: string, auth: Object) Constructor

Member Summary

Public Members
public	itemClass: Object

Method Summary

Public Methods
public	getPlugins(searchParams: Object, timeout: number): Object Fetch a list of plugins from the REST API.
public	post(data: Object, timeout: number): Object Make a POST request to this pipeline list resource to create a new pipeline item resource through the REST API.

Inherited Summary

From class Resource
public get	isEmpty: boolean Return true if the resource object contains any data.
public	auth: Object
public	collection: Object
public	contentType: string
public	url: string
public	clone(): Object Make a deep copy clone of this object resource.

From class ListResource
public get	data: Object[] Get the list of item data objects (REST API descriptors).
public get	hasNextPage: boolean Return true if the list resource object has a next list page in the paginated REST API.
public get	hasPreviousPage: boolean Return true if the list resource object has a previous list page in the paginated REST API.
public get	totalCount: number Get the total count of items of the entire collection across pages in the paginated REST API.
public	collection: *
public	itemClass: Object
public	queryUrl: string
public	searchParams: Object
public	get(searchParams: Object, timeout: number): Object Fetch this list resource from the REST API based on search parameters.
public	getItem(id: number): Object Get an item resource object given its id from the list of items in this list resource object.
public	getItems(): Object[] Get an array of item resource objects corresponding to the items in this list resource object.
public	getPOSTParameters(): string[] Get an array of parameter names that can be used as properties of the data object in POST requests.
public	getSearchParameters(): string[] Get an array of search parameter names that can be used as properties of the `searchParams` argument to the `get` method.
private	_getResource(linkRelation: string, ResourceClass: Object, searchParams: Object, timeout: number): Object Internal method to fetch a related resource from the REST API that is referenced by a link relation within this list resource's collection object.
private	_post(data: Object, uploadFileObj: Object, timeout: number): Object Internal helper method to make a POST request to this list resource through the REST API.

Public Constructors

public constructor(url: string, auth: Object) source

Constructor

Override:

ListResource#constructor

Params:

Name	Type	Attribute	Description
url	string		url of the resource
auth	Object	optional default: null	authentication object
auth.token	string	optional	authentication token

Public Members

public itemClass: Object source

Override:

ListResource#itemClass

Public Methods

public getPlugins(searchParams: Object, timeout: number): Object source

Fetch a list of plugins from the REST API.

Params:

Name	Type	Attribute	Description
searchParams	Object	optional default: null	search parameters object which is resource-specific, the `PluginList.getSearchParameters` method can be used to get a list of possible search parameters
searchParams.limit	number	optional	page limit
searchParams.offset	number	optional	page offset
timeout	number	optional default: 30000	request timeout

Return:

Object

JS Promise, resolves to a PluginList object

public post(data: Object, timeout: number): Object source

Make a POST request to this pipeline list resource to create a new pipeline item resource through the REST API.

Params:

Name	Type	Attribute	Description
data	Object		request JSON data object
data.name	string		pipeline name
data.plugin_tree	string		JSON string containing a plugin tree list
data.authors	string	optional	pipeline authors
data.category	string	optional	pipeline category
data.description	string	optional	pipeline description
data.locked	boolean	optional default: true	pipeline status
timeout	number	optional default: 30000	request timeout

Return:

Object

JS Promise, resolves to this object