Home Reference Source
import User from '@fnndsc/chrisstoreapi'
public class | source

User

Extends:

ResourceItemResource → User

User item resource object representing a user of the system.

Constructor Summary

Public Constructor
public

constructor(url: string, auth: Object)

Constructor

Method Summary

Public Methods
public

put(data: Object, timeout: number): Object

Make a PUT request to modify this user item resource through the REST API.

Inherited Summary

From class 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): Object

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): Object

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): Object

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): Object

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

Public Constructors

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

Constructor

Override:

ItemResource#constructor

Params:

NameTypeAttributeDescription
url string

url of the resource

auth Object

authentication object

auth.token string

authentication token

Public Methods

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

Make a PUT request to modify this user item resource through the REST API.

Params:

NameTypeAttributeDescription
data Object

request JSON data object

data.password string

user password

data.email string

user email

timeout number
  • optional
  • default: 30000

request timeout

Return:

Object

JS Promise, resolves to this object