Skip to main content

Module: rest

Classes

Type Aliases

DataExtractor

Ƭ DataExtractor: (document: any) => Awaitable<RestResource[] | RestResource | RestNewResource | null>

Type declaration

▸ (document): Awaitable<RestResource[] | RestResource | RestNewResource | null>

Parameters
NameType
documentany
Returns

Awaitable<RestResource[] | RestResource | RestNewResource | null>

Defined in

src/rest/types.ts:29


DataReader

Ƭ DataReader: (response: Response) => Awaitable<any>

Type declaration

▸ (response): Awaitable<any>

Parameters
NameType
responseResponse
Returns

Awaitable<any>

Defined in

src/rest/types.ts:28


DataWrapper

Ƭ DataWrapper: (resource: Dictionary) => Awaitable<Dictionary>

Type declaration

▸ (resource): Awaitable<Dictionary>

Parameters
NameType
resourceDictionary
Returns

Awaitable<Dictionary>

Defined in

src/rest/types.ts:32


RestAbstractResource

Ƭ RestAbstractResource: Dictionary & { type?: string }

Defined in

src/rest/types.ts:7


RestDeserializerConfig

Ƭ RestDeserializerConfig: ObjectDeserializerConfig & { dataExtractor?: DataExtractor | null ; dataReader?: DataReader }

Defined in

src/rest/types.ts:19


RestNewResource

Ƭ RestNewResource: RestAbstractResource & { id?: RestResourceId }

Defined in

src/rest/types.ts:15


RestResource

Ƭ RestResource: RestAbstractResource & { id: RestResourceId }

Defined in

src/rest/types.ts:11


RestResourceId

Ƭ RestResourceId: ModelIdType

Defined in

src/rest/types.ts:5


RestSerializerConfig

Ƭ RestSerializerConfig: ObjectSerializerConfig & { dataWrapper?: DataWrapper | null }

Defined in

src/rest/types.ts:24