Class FastifyFullTransformerAPI<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>
FastifyListTransformerAPI<T, B, F>
PatchTransformerAPI<T, B, F>
DeleteTransformerAPI<T>
- FastifyFullTransformerAPI

Index

Constructors

constructor

new FastifyFullTransformerAPI<T, B, F>(instance, baseURL, transformer, isFormData?): FastifyFullTransformerAPI<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 FastifyFullTransformerAPI<T, B, F>
Inherited from DeleteTransformerAPI.constructor
- Defined in src/infra/api/FullTransformerAPI.ts:54

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 FastifyListTransformerAPI.getFirst
- Defined in src/infra/api/FastifyListTransformerAPI.ts:19

list

list(paginatedFilter?, params?): Promise<{
    code: string;
    error: false;
    message: string;
    next: number;
    previous: number;
    results: F[];
    statusCode: HttpStatusCode;
    total: number;
}>
Parameters
- paginatedFilter: FastifyPaginatedFilter = FrontUtilsConfig.fastifyPaginatedFilter
- params: object = {}
Returns Promise<{
    code: string;
    error: false;
    message: string;
    next: number;
    previous: number;
    results: F[];
    statusCode: HttpStatusCode;
    total: number;
}>
Inherited from FastifyListTransformerAPI.list
- Defined in src/infra/api/FastifyListTransformerAPI.ts:29

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

Class FastifyFullTransformerAPI<T, B, F>

Type Parameters

T extends IBaseTransformer<B, F>

B extends object = inferTransformerBack<T>

F extends object = inferTransformerFront<T>

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

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 FastifyFullTransformerAPI<T, B, F>

Accessors

baseURL

Returns string

instance

Returns AxiosInstance

transformer

Returns T

Methods

delete

Parameters

id: string | number = ''

Returns Promise<void>

get

Parameters

id: string | number = ''

params: object = {}

Returns Promise<F>

getFirst

Parameters

params: object = {}

Returns Promise<undefined | F>

list

Parameters

paginatedFilter: FastifyPaginatedFilter = FrontUtilsConfig.fastifyPaginatedFilter

params: object = {}

Returns Promise<{ code: string; error: false; message: string; next: number; previous: number; results: F[]; statusCode: HttpStatusCode; total: number; }>

patch

Parameters

id: string | number = ''

payload: Partial<F>

Returns Promise<F>

post

Parameters

payload: Partial<F>

Returns Promise<F>

Protected prepareToSend

Type Parameters

T extends object

Parameters

payload: T

Returns object

Settings

Member Visibility

Theme

On This Page

`Optional` isFormData: boolean

Returns Promise<{
code: string;
error: false;
message: string;
next: number;
previous: number;
results: F[];
statusCode: HttpStatusCode;
total: number;
}>

`Protected` prepareToSend