Class DjangoFullTransformerAPI<T, B, F>

Type Parameters

T extends IBaseTransformer<B, F>
B extends object = inferTransformerBack<T>
F extends object = inferTransformerFront<T>

Hierarchy

GetTransformerAPI<T, B, F>
PostTransformerAPI<T, B, F>
DjangoListTransformerAPI<T, B, F>
PatchTransformerAPI<T, B, F>
DeleteTransformerAPI<T>
- DjangoFullTransformerAPI

Index

Constructors

Accessors

baseURL instance transformer

Methods

delete get getFirst list patch post prepareToSend

Constructors

constructor

new DjangoFullTransformerAPI<T, B, F>(instance, baseURL, transformer, isFormData?): DjangoFullTransformerAPI<T, B, F>
Type Parameters
- T extends IBaseTransformer<B, F, T>
- B extends object = inferTransformerBack<T>
- F extends object = inferTransformerFront<T>
Parameters
- instance: AxiosInstance
- baseURL: string
- transformer: T
- Optional isFormData: boolean
Returns DjangoFullTransformerAPI<T, B, F>
Inherited from DeleteTransformerAPI.constructor
- Defined in src/infra/api/FullTransformerAPI.ts:22

Accessors

baseURL

get baseURL(): string
Returns string
- Defined in src/infra/api/BaseAPI.ts:14

instance

get instance(): AxiosInstance
Returns AxiosInstance
- Defined in src/infra/api/BaseAPI.ts:11

transformer

get transformer(): T
Returns T
- Defined in src/infra/api/BaseTransformerAPI.ts:23

Methods

delete

delete(id?): Promise<void>
Parameters
- id: string | number = ''
Returns Promise<void>
Inherited from DeleteTransformerAPI.delete
- Defined in src/infra/api/DeleteTransformerAPI.ts:14

get

get(id?, params?): Promise<F>
Parameters
- id: string | number = ''
- params: object = {}
Returns Promise<F>
Inherited from GetTransformerAPI.get
- Defined in src/infra/api/GetTransformerAPI.ts:18

getFirst

getFirst(params?): Promise<undefined | F>
Parameters
- params: object = {}
Returns Promise<undefined | F>
Inherited from DjangoListTransformerAPI.getFirst
- Defined in src/infra/api/DjangoListTransformerAPI.ts:22

list

list(paginatedFilter?, params?): Promise<{
    count: number;
    next: string;
    previous: string;
    results: F[];
}>
Parameters
- paginatedFilter: DjangoPaginatedFilter = FrontUtilsConfig.djangoPaginatedFilter
- params: object = {}
Returns Promise<{
    count: number;
    next: string;
    previous: string;
    results: F[];
}>
Inherited from DjangoListTransformerAPI.list
- Defined in src/infra/api/DjangoListTransformerAPI.ts:32

patch

patch(id?, payload): Promise<F>
Parameters
- id: string | number = ''
- payload: Partial<F>
Returns Promise<F>
Inherited from PatchTransformerAPI.patch
- Defined in src/infra/api/PatchTransformerAPI.ts:21

post

post(payload): Promise<F>
Parameters
- payload: Partial<F>
Returns Promise<F>
Inherited from PostTransformerAPI.post
- Defined in src/infra/api/PostTransformerAPI.ts:22

`Protected` prepareToSend

prepareToSend<T>(payload): object
Type Parameters
- T extends object
Parameters
- payload: T
Returns object
Inherited from DeleteTransformerAPI.prepareToSend
- Defined in src/infra/api/BaseTransformerAPI.ts:27

Generated using TypeDoc