Interface EndpointDefBuilder<Root>

Builder interface to define an endpoint

Type Parameters

Root extends EndpointDefBase

Index

Properties

root

Methods

bodyOpt bodyReq error queryOpt queryReq

Properties

`Readonly` root

root: Root

Definition shape of an endpoint

Methods

bodyOpt

bodyOpt<Body>(body): EndpointDefBuilder<Expand<Root & Record<typeof $bodyOpt, Body>>>
Provides a shape of optional data that can be passed as a body to an endpoint
Type Parameters
- Body extends GenericData
  Shape of optional body data
Parameters
- body: Body
  Shape of optional body data
Returns EndpointDefBuilder<Expand<Root & Record<typeof $bodyOpt, Body>>>
Example: Using the bodyOpt function
```
...get({}, $get =>
  $get.bodyOpt({ userId: 0 })
)...
```
bodyOpt<Body, AltResp>(body, altResp): EndpointDefBuilder<Expand<Root & Record<typeof $bodyOpt, Body> & Record<typeof $responseAltBody, AltResp>>>
Provides a shape of optional data that can be passed as a body to an endpoint as well as an alternate shape for the API to respond
Type Parameters
- Body extends GenericData
  Shape of optional body data
- AltResp extends GenericData
  Shape of the alternate response
Parameters
- body: Body
  Shape of optional body data
- altResp: AltResp
  Shape of the alternate response
Returns EndpointDefBuilder<Expand<Root & Record<typeof $bodyOpt, Body> & Record<typeof $responseAltBody, AltResp>>>
Example: Using the bodyOpt function
```
...get({}, $get =>
  $get.bodyOpt({ userId: 0 })
)...
```

bodyReq

bodyReq<Body>(body): EndpointDefBuilder<Expand<Root & Record<typeof $bodyReq, Body>>>
Provides a shape of required data that must be passed as a body to an endpoint
Type Parameters
- Body extends GenericData
  Shape of required body data
Parameters
- body: Body
  Shape of required body data
Returns EndpointDefBuilder<Expand<Root & Record<typeof $bodyReq, Body>>>
Example: Using the bodyReq function
```
...get({}, $get =>
  $get.bodyReq({ userId: 0 })
)...
```
bodyReq<Body, AltResp>(body, altResp): EndpointDefBuilder<Expand<Root & Record<typeof $bodyReq, Body> & Record<typeof $responseAltBody, AltResp>>>
Provides a shape of required data that must be passed as a body to an endpoint as well as an alternate shape for the API to respond
Type Parameters
- Body extends GenericData
  Shape of required body data
- AltResp extends GenericData
  Shape of the alternate response
Parameters
- body: Body
  Shape of required body data
- altResp: AltResp
  Shape of the alternate response
Returns EndpointDefBuilder<Expand<Root & Record<typeof $bodyReq, Body> & Record<typeof $responseAltBody, AltResp>>>
Example: Using the bodyReq function
```
...get({}, $get =>
  $get.bodyReq({ userId: 0 })
)...
```

error

error<Error>(error): EndpointDefBuilder<Expand<Root & Record<typeof $error, Error>>>
Provides a shape of the error response an API. This is used to detect API-generated errors that are passed with successful 200 responses
Type Parameters
- Error extends GenericData
  Shape of the error response
Parameters
- error: Error
  Shape of the error response
Returns EndpointDefBuilder<Expand<Root & Record<typeof $error, Error>>>
Example: Using the error function
```
...get({}, $get =>
  $get.error({ message: '' })
)...
```

queryOpt

queryOpt<Query>(query): EndpointDefBuilder<Expand<Root & Record<typeof $queryOpt, Query>>>
Provides a shape of optional data that can be passed as query parameters to an endpoint
Type Parameters
- Query extends QueryParams
  Shape of optional query params
Parameters
- query: Query
  Shape of optional query params
Returns EndpointDefBuilder<Expand<Root & Record<typeof $queryOpt, Query>>>
Example: Using the queryOpt function
```
...get({}, $get =>
  $get.queryOpt({ userId: 0 })
)...
```
queryOpt<Query, AltResp>(query, altResp): EndpointDefBuilder<Expand<Root & Record<typeof $queryOpt, Query> & Record<typeof $responseAltQuery, AltResp>>>
Provides a shape of optional data that can be passed as query parameters to an endpoint as well as an alternate shape for the API to respond
Type Parameters
- Query extends QueryParams
  Shape of optional query params
- AltResp extends GenericData
  Shape of the alternate response
Parameters
- query: Query
  Shape of optional query params
- altResp: AltResp
  Shape of the alternate response
Returns EndpointDefBuilder<Expand<Root & Record<typeof $queryOpt, Query> & Record<typeof $responseAltQuery, AltResp>>>
Example: Using the queryOpt function
```
...get({}, $get =>
  $get.queryOpt({ userId: 0 })
)...
```

queryReq

queryReq<Query>(query): EndpointDefBuilder<Expand<Root & Record<typeof $queryReq, Query>>>
Provides a shape of required data that must be passed as query parameters to an endpoint
Type Parameters
- Query extends QueryParams
  Shape of required query params
Parameters
- query: Query
  Shape of required query params
Returns EndpointDefBuilder<Expand<Root & Record<typeof $queryReq, Query>>>
Example: Using the queryReq function
```
...get({}, $get =>
  $get.queryReq({ userId: 0 })
)...
```
queryReq<Query, AltResp>(query, altResp): EndpointDefBuilder<Expand<Root & Record<typeof $queryReq, Query> & Record<typeof $responseAltQuery, AltResp>>>
Provides a shape of required data that must be passed as query parameters to an endpoint as well as an alternate shape for the API to respond
Type Parameters
- Query extends QueryParams
  Shape of required query params
- AltResp extends GenericData
  Shape of the alternate response
Parameters
- query: Query
  Shape of required query params
- altResp: AltResp
  Shape of the alternate response
Returns EndpointDefBuilder<Expand<Root & Record<typeof $queryReq, Query> & Record<typeof $responseAltQuery, AltResp>>>
Example: Using the queryReq function
```
...get({}, $get =>
  $get.queryReq({ userId: 0 })
)...
```

Interface EndpointDefBuilder<Root>

Type Parameters

Index

Properties

Methods

Properties

Readonly root

Methods

bodyOpt

Type Parameters

Parameters

Returns EndpointDefBuilder<Expand<Root & Record<typeof $bodyOpt, Body>>>

Example: Using the bodyOpt function

Type Parameters

Parameters

Returns EndpointDefBuilder<Expand<Root & Record<typeof $bodyOpt, Body> & Record<typeof $responseAltBody, AltResp>>>

Example: Using the bodyOpt function

bodyReq

Type Parameters

Parameters

Returns EndpointDefBuilder<Expand<Root & Record<typeof $bodyReq, Body>>>

Example: Using the bodyReq function

Type Parameters

Parameters

Returns EndpointDefBuilder<Expand<Root & Record<typeof $bodyReq, Body> & Record<typeof $responseAltBody, AltResp>>>

Example: Using the bodyReq function

error

Type Parameters

Parameters

Returns EndpointDefBuilder<Expand<Root & Record<typeof $error, Error>>>

Example: Using the error function

queryOpt

Type Parameters

Parameters

Returns EndpointDefBuilder<Expand<Root & Record<typeof $queryOpt, Query>>>

Example: Using the queryOpt function

Type Parameters

Parameters

Returns EndpointDefBuilder<Expand<Root & Record<typeof $queryOpt, Query> & Record<typeof $responseAltQuery, AltResp>>>

Example: Using the queryOpt function

queryReq

Type Parameters

Parameters

Returns EndpointDefBuilder<Expand<Root & Record<typeof $queryReq, Query>>>

Example: Using the queryReq function

Type Parameters

Parameters

Returns EndpointDefBuilder<Expand<Root & Record<typeof $queryReq, Query> & Record<typeof $responseAltQuery, AltResp>>>

Example: Using the queryReq function

Settings

Member Visibility

Theme

On This Page

`Readonly` root