ApiEndpoint

interface ApiEndpoint<TRequest = void, TResponse = void, TParams = void, TQuery = void> {
params: TParams;
query: TQuery;
request: TRequest;
response: TResponse;
}

Source: api.ts:368

API endpoint definition

Type Parameters

TRequest = void — Request body type
TResponse = void — Response data type
TParams = void — URL parameters type
TQuery = void — Query parameters type

Example

CODE

type GetUserEndpoint = ApiEndpoint<
  void,           // No request body
  User,           // Returns User
  { id: string }, // URL has id param
  void            // No query params
>

Properties

`params: TParams`

api.ts:379

URL parameters type

`query: TQuery`

api.ts:381

Query parameters type

`request: TRequest`

api.ts:375

Request body type

`response: TResponse`

api.ts:377

Response data type