DefaultDataResource | typescript-api-platform

Type parameters

T: IdData<any>

Hierarchy

AbstractDataResource<T>
- DefaultDataResource

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DefaultDataResource(axios: AxiosInstance, dataName: string): DefaultDataResource

Overrides AbstractGetEntityResource.constructor
- Defined in resource/DefaultDataResource.ts:5
Parameters
- axios: AxiosInstance
- dataName: string
Returns DefaultDataResource

Properties

Protected axios

axios: AxiosInstance

Protected Optional objectFactory

objectFactory: undefined | function

Methods

create

create(object: T): Promise<T & AxiosResponseExt>

Inherited from AbstractEntityResource.create
- Defined in resource/AbstractEntityResource.ts:27
Parameters
- object: T
Returns Promise<T & AxiosResponseExt>

delete

delete(id: string): Promise<T & AxiosResponseExt>

Inherited from AbstractEntityResource.delete
- Defined in resource/AbstractEntityResource.ts:37
Parameters
- id: string
Returns Promise<T & AxiosResponseExt>

deleteFromObject

deleteFromObject(object: T): Promise<T & AxiosResponseExt>

Inherited from AbstractEntityResource.deleteFromObject
- Defined in resource/AbstractEntityResource.ts:33
Parameters
- object: T
Returns Promise<T & AxiosResponseExt>

get

get(id: string, cancelTokenSource?: CancelTokenSource): Promise<T & AxiosResponseExt>

Inherited from AbstractGetEntityResource.get
- Defined in resource/AbstractGetEntityResource.ts:26
Parameters
- id: string
- Optional cancelTokenSource: CancelTokenSource
Returns Promise<T & AxiosResponseExt>

getFromObject

getFromObject(object: T): Promise<T & AxiosResponseExt>

Inherited from AbstractEntityResource.getFromObject
- Defined in resource/AbstractEntityResource.ts:17
Parameters
- object: T
Returns Promise<T & AxiosResponseExt>

getIdPathRepresentation

getIdPathRepresentation(id: string): string

Inherited from AbstractGetEntityResource.getIdPathRepresentation
- Defined in resource/AbstractGetEntityResource.ts:22
Parameters
- id: string
Returns string

getObjectId

getObjectId(object: T): string

Inherited from AbstractDataResource.getObjectId

Overrides AbstractEntityResource.getObjectId
- Defined in resource/AbstractDataResource.ts:7
Parameters
- object: T
Returns string

getPath

getPath(id?: K): string

Inherited from AbstractGetEntityResource.getPath
- Defined in resource/AbstractGetEntityResource.ts:13
Parameters
- Optional id: K
Returns string

getPathFromObject

getPathFromObject(object?: T): string

Inherited from AbstractEntityResource.getPathFromObject
- Defined in resource/AbstractEntityResource.ts:8
Parameters
- Optional object: T
Returns string

list

list(cancelTokenSource?: CancelTokenSource): Promise<T[] & AxiosResponseExt>

Inherited from AbstractEntityResource.list
- Defined in resource/AbstractEntityResource.ts:21
Parameters
- Optional cancelTokenSource: CancelTokenSource
Returns Promise<T[] & AxiosResponseExt>

update

update(object: T): Promise<T & AxiosResponseExt>

Inherited from AbstractEntityResource.update
- Defined in resource/AbstractEntityResource.ts:42
Parameters
- object: T
Returns Promise<T & AxiosResponseExt>

Protected wrapHydraItem

wrapHydraItem(data: any): any & object

Inherited from AbstractResource.wrapHydraItem
- Defined in resource/AbstractResource.ts:31
Parameters
- data: any
Returns any & object

Protected wrapPromise

wrapPromise(axiosPromise: AxiosPromise, objectFactory?: undefined | function): Promise<Object>

Inherited from AbstractResource.wrapPromise
- Defined in resource/AbstractResource.ts:49
Parameters
- axiosPromise: AxiosPromise
- Optional objectFactory: undefined | function
Returns Promise<Object>

Generated using TypeDoc