Class Resource<S, R>

Type Parameters

S extends Schema
R

Hierarchy

Request<S, R>
- Resource

Index

Constructors

constructor

new Resource<S extends Schema, R>(
 chatter: Chatter<S>,
 url: string,
 queryParams?: { [name: string]: string | number | boolean | null } | null,
): Resource<S, R>
Type Parameters
- S extends Schema
- R
Parameters
- chatter: Chatter<S>
- url: string
- OptionalqueryParams: { [name: string]: string | number | boolean | null } | null
Returns Resource<S, R>
Overrides Request<S, R>.constructor
- Defined in src/api/chatter.ts:124

Properties

_chatter

_chatter: Chatter<S>

_promise

_promise: Promise<R> | undefined

_request

_request: ChatterRequestParams

_url

_url: string

del

del: () => Request<S, void> = ...

Synonym of Resource#destroy()

Type Declaration

- (): Request<S, void>
- Delete specified resource
 
 Returns Request<S, void>

delete

delete: () => Request<S, void> = ...

Synonym of Resource#destroy()

Type Declaration

- (): Request<S, void>
- Delete specified resource
 
 Returns Request<S, void>

Methods

batchParams

batchParams(): {
    method: HttpMethods;
    richInput?: string
    | object
    | null;
    url: string;
}
Retrieve parameters in batch request form

Returns { method: HttpMethods; richInput?: string | object | null; url: string }
Inherited from Request.batchParams
- Defined in src/api/chatter.ts:56

create

create<R1 = any>(data: string | object | null): Request<S, R1>
Create a new resource
Type Parameters
- R1 = any
Parameters
- data: string | object | null
Returns Request<S, R1>
- Defined in src/api/chatter.ts:139

destroy

destroy(): Request<S, void>
Delete specified resource

Returns Request<S, void>
- Defined in src/api/chatter.ts:171

promise

promise(): Promise<R>
Retrieve parameters in batch request form

Returns Promise<R>

Method
Chatter~Request#promise
Inherited from Request.promise
- Defined in src/api/chatter.ts:71

retrieve

retrieve<R1 = R>(): Request<S, R1>
Retrieve resource content
Type Parameters
- R1 = R
Returns Request<S, R1>
- Defined in src/api/chatter.ts:150

stream

stream(): Duplex
Returns Node.js Stream object for request

Returns Duplex

Method
Chatter~Request#stream
Inherited from Request.stream
- Defined in src/api/chatter.ts:83

then

then(
onResolve?: (value: R) => U | PromiseLike,
onReject?: (e: any) => U | PromiseLike,
): Promise
Promise/A+ interface http://promises-aplus.github.io/promises-spec/

Delegate to deferred promise, return promise instance for batch result
Type Parameters
- U
Parameters
- OptionalonResolve: (value: R) => U | PromiseLike
- OptionalonReject: (e: any) => U | PromiseLike
Returns Promise
Inherited from Request.then
- Defined in src/api/chatter.ts:93

update

update<R1 = any>(data: object): Request<S, R1>
Update specified resource
Type Parameters
- R1 = any
Parameters
- data: object
Returns Request<S, R1>
- Defined in src/api/chatter.ts:160

Class Resource<S, R>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Resource<S, R>

Properties

_chatter

_promise

_request

_url

del

Type Declaration

Returns Request<S, void>

delete

Type Declaration

Returns Request<S, void>

Methods

batchParams

Returns { method: HttpMethods; richInput?: string | object | null; url: string }

create

Type Parameters

Parameters

Returns Request<S, R1>

destroy

Returns Request<S, void>

promise

Returns Promise<R>

Method

retrieve

Type Parameters

Returns Request<S, R1>

stream

Returns Duplex

Method

then

Type Parameters

Parameters

Returns Promise<U>

update

Type Parameters

Parameters

Returns Request<S, R1>

Settings

On This Page