Class PatchTransformerAPI<T, B, F>

Type Parameters

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

Hierarchy

BaseTransformerAPI<T>
- PatchTransformerAPI
  - DjangoFullTransformerAPI
  - FastifyFullTransformerAPI

Index

Constructors

Accessors

baseURL instance transformer

Methods

patch prepareToSend

Constructors

constructor

new PatchTransformerAPI<T, B, F>(instance, baseURL, transformer, isFormData?): PatchTransformerAPI<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 PatchTransformerAPI<T, B, F>
Overrides BaseTransformerAPI.constructor
- Defined in src/infra/api/PatchTransformerAPI.ts:12

Accessors

baseURL

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

instance

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

transformer

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

Methods

patch

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

`Protected` prepareToSend

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

Generated using TypeDoc