AbstractApiResource | typescript-api-platform

Type parameters

ResponseType
InputType

Hierarchy

AbstractResource
- AbstractApiResource

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AbstractApiResource(axios: AxiosInstance, ObjectConstructor?: undefined | object): AbstractApiResource

Inherited from AbstractResource.constructor
- Defined in resource/AbstractResource.ts:10
Parameters
- axios: AxiosInstance
- Optional ObjectConstructor: undefined | object
Returns AbstractApiResource

Properties

Protected axios

axios: AxiosInstance

Protected Optional objectFactory

objectFactory: undefined | function

Abstract prefix

prefix: string

Methods

Protected buildParams

buildParams(options?: GetOptions | GetOneOptions): string[]

- Defined in resource/AbstractApiResource.ts:66
Parameters
- Optional options: GetOptions | GetOneOptions
Returns string[]

Protected buildSearch

buildSearch(field: string, query: string | number | boolean, type: string | undefined, isArray?: boolean): string

- Defined in resource/AbstractApiResource.ts:18
Parameters
- field: string
- query: string | number | boolean
- type: string | undefined
- Default value isArray: boolean = false
Returns string

Protected buildUrl

buildUrl(path: string, options?: GetOptions | GetOneOptions): string

- Defined in resource/AbstractApiResource.ts:79
Parameters
- path: string
- Optional options: GetOptions | GetOneOptions
Returns string

count

count<GetResponseType>(options?: GetOptions): Promise<number & AxiosResponseExt>

- Defined in resource/AbstractApiResource.ts:94
Type parameters
- GetResponseType
Parameters
- Optional options: GetOptions
Returns Promise<number & AxiosResponseExt>

delete

delete<DeleteResponseType>(id: number | string, options?: GetOneOptions): Promise<ResponseType & AxiosResponseExt>

- Defined in resource/AbstractApiResource.ts:140
Type parameters
- DeleteResponseType
Parameters
- id: number | string
- Optional options: GetOneOptions
Returns Promise<ResponseType & AxiosResponseExt>

get

get<GetResponseType>(options?: GetOptions): Promise<GetResponseType[] & AxiosResponseExt>

- Defined in resource/AbstractApiResource.ts:116
Type parameters
- GetResponseType
Parameters
- Optional options: GetOptions
Returns Promise<GetResponseType[] & AxiosResponseExt>

getAll

getAll<GetResponseType>(options?: GetOptions): Promise<GetResponseType[] & AxiosResponseExt>

- Defined in resource/AbstractApiResource.ts:108
Type parameters
- GetResponseType
Parameters
- Optional options: GetOptions
Returns Promise<GetResponseType[] & AxiosResponseExt>

getOne

getOne<GetResponseType>(id: number | string, options?: GetOneOptions): Promise<GetResponseType & AxiosResponseExt>

- Defined in resource/AbstractApiResource.ts:124
Type parameters
- GetResponseType
Parameters
- id: number | string
- Optional options: GetOneOptions
Returns Promise<GetResponseType & AxiosResponseExt>

Protected loadPage

loadPage(params: string[], options: GetOptions): void

- Defined in resource/AbstractApiResource.ts:52
Parameters
- params: string[]
- options: GetOptions
Returns void

Protected loadProps

loadProps(params: string[], options: GetOneOptions): void

- Defined in resource/AbstractApiResource.ts:12
Parameters
- params: string[]
- options: GetOneOptions
Returns void

Protected loadSearches

loadSearches(params: string[], options: GetOptions): void

- Defined in resource/AbstractApiResource.ts:28
Parameters
- params: string[]
- options: GetOptions
Returns void

Protected loadSort

loadSort(params: string[], options: GetOptions): void

- Defined in resource/AbstractApiResource.ts:46
Parameters
- params: string[]
- options: GetOptions
Returns void

patch

patch<PatchInputType, PatchResponseType>(id: number | string, item: PatchInputType, options?: GetOneOptions): Promise<PatchResponseType & AxiosResponseExt>

- Defined in resource/AbstractApiResource.ts:156
Type parameters
- PatchInputType
- PatchResponseType
Parameters
- id: number | string
- item: PatchInputType
- Optional options: GetOneOptions
Returns Promise<PatchResponseType & AxiosResponseExt>

post

post<PostInputType, PostResponseType>(item: PostInputType, options?: GetOneOptions): Promise<PostResponseType & AxiosResponseExt>

- Defined in resource/AbstractApiResource.ts:132
Type parameters
- PostInputType
- PostResponseType
Parameters
- item: PostInputType
- Optional options: GetOneOptions
Returns Promise<PostResponseType & AxiosResponseExt>

Protected preProcessData

preProcessData(item: any): any

- Defined in resource/AbstractApiResource.ts:84
Parameters
- item: any
Returns any

put

put<PutInputType, PutResponseType>(id: number | string, item: PutInputType, options?: GetOneOptions): Promise<PutResponseType & AxiosResponseExt>

- Defined in resource/AbstractApiResource.ts:148
Type parameters
- PutInputType
- PutResponseType
Parameters
- id: number | string
- item: PutInputType
- Optional options: GetOneOptions
Returns Promise<PutResponseType & 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