Class Endpoint<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>

constructor

• new Endpoint<
      TResponse = any,
      TParams extends string | undefined = string | undefined,
      TQuery extends Query = Query,
      TBody extends Body | undefined = Body | undefined,
      TState extends State = State,
      TPath extends string = string,
      TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined,
      TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined,
  >(
      api: Api,
      options: EndpointOptions<
          TResponse,
          TParams,
          TQuery,
          TBody,
          TState,
          TPath,
          TRequestHeaders,
          TResponseHeaders,
      >,
  ): Endpoint<
      TResponse,
      TParams,
      TQuery,
      TBody,
      TState,
      TPath,
      TRequestHeaders,
      TResponseHeaders,
  >

  Type Parameters

  • TResponse = any
  • TParams extends string | undefined = string | undefined
  • TQuery extends Query = Query
  • TBody extends Body | undefined = Body | undefined
  • TState extends State = State
  • TPath extends string = string
  • TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined
  • TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined

  Parameters

  • api: Api
  • options: EndpointOptions<
        TResponse,
        TParams,
        TQuery,
        TBody,
        TState,
        TPath,
        TRequestHeaders,
        TResponseHeaders,
    >

  Returns Endpoint<
      TResponse,
      TParams,
      TQuery,
      TBody,
      TState,
      TPath,
      TRequestHeaders,
      TResponseHeaders,
  >

Readonlyapi

baseUrl

• get baseUrl(): string

  Returns string

config

• get config(): BaseRequestConfig

  Returns BaseRequestConfig

  Deprecated

  Use defaultRequestConfig instead

defaultRequestConfig

• get defaultRequestConfig(): BaseRequestConfig

  Default request configuration for this endpoint

  Returns BaseRequestConfig

description

• get description(): string | undefined

  Describe your endpoint to help with debugging and documentation

  Returns string | undefined

id

• get id(): string

  Returns string

method

• get method(): RequestMethod

  Returns RequestMethod

middleware

• get middleware(): RequestMiddleware[]

  Middleware specific to this endpoint. These will be executed after API-level middleware.

  Returns RequestMiddleware[]

mocking

• get mocking(): | EndpointMockingConfig<
      TResponse,
      TParams,
      TQuery,
      TBody,
      TState,
  >
  | undefined

  Specify mocking for your endpoint upfront to help with disconnected dev, and testing. Enable/disable mocked returns for all endpoints on your API object.

  Returns EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState> | undefined

name

• get name(): string

  Name your endpoint to help with debugging and documentation

  Returns string

  Default

  id is used as the name if no name is supplied

path

• get path(): TPath

  Returns TPath

responseType

• get responseType(): ResponseType | undefined

  Let the backend requestor (fetch, axios, etc.) know what type of response you are expecting from this endpoint

  Returns ResponseType | undefined

  Default

  application/json

validation

• get validation(): Validation<TResponse, TParams, TQuery, TBody, TState>

  Returns Validation<TResponse, TParams, TQuery, TBody, TState>

computeConfig

• computeConfig<
      TParams extends string
      | undefined,
      TQuery extends Query,
      TBody extends Body | undefined,
      TState extends State,
      TRequestHeaders extends RawHeaders | undefined,
  >(
      config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>,
  ): ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>

  Type Parameters

  • TParams extends string | undefined
  • TQuery extends Query
  • TBody extends Body | undefined
  • TState extends State
  • TRequestHeaders extends RawHeaders | undefined

  Parameters

  • config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>

  Returns ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>

  Deprecated

  Use defaultRequestConfig instead

computeRequestConfig

• computeRequestConfig<
      TParams extends string
      | undefined,
      TQuery extends Query,
      TBody extends Body | undefined,
      TState extends State,
      TRequestHeaders extends RawHeaders | undefined,
  >(
      config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>,
  ): ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>

  Type Parameters

  • TParams extends string | undefined
  • TQuery extends Query
  • TBody extends Body | undefined
  • TState extends State
  • TRequestHeaders extends RawHeaders | undefined

  Parameters

  • config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>

  Returns ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>

getRequestBackend

• getRequestBackend(): RequestBackend

  Returns RequestBackend

resolvePath

• resolvePath(options: EndpointResolvePathOptions<TParams>): string

  Parameters

  • options: EndpointResolvePathOptions<TParams>

  Returns string

resolveUrl

• resolveUrl(options: EndpointResolveUrlOptions<TParams, TQuery>): Promise<URL>

  Parameters

  • options: EndpointResolveUrlOptions<TParams, TQuery>

  Returns Promise<URL>

submit

• submit(
      config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>,
  ): Promise<ApiResponse<TResponse>>

  Parameters

  • config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>

  Returns Promise<ApiResponse<TResponse>>