Skip to main content

Interface: SubnameSearchRoute

Represents a generic API route configuration, encapsulating the types for request and response bodies, as well as any required headers. This interface serves as a template for defining the contract for a specific API endpoint, ensuring type safety and consistency in request/response handling.

  • request: Specifies the expected structure of the request body, derived from IRequest.

  • response: Specifies the expected structure of the response body, derived from IResponse.

  • headers: Specifies the expected structure of the request/response headers, derived from IHeaders.

    IRoute

Hierarchy​

Properties​

headers​

• headers: Object

The type of the headers for the request/response.

Overrides​

IRoute.headers

Defined in​

lib/types/subnames/search-subnames.ts:75

request​

• request: SubnameSearchRequest

The type of the request data.

Overrides​

IRoute.request

Defined in​

lib/types/subnames/search-subnames.ts:73

response​

• response: SubnameSearchResponse

The type of the response data.

Overrides​

IRoute.response

Defined in​

lib/types/subnames/search-subnames.ts:74