Function: defineEndpoint()

defineEndpoint<T>(endpoint): T

Defined in: src/endpoint.ts:85

Defines an endpoint with full type inference.

Type Parameters

Type Parameter
T extends Endpoint

Parameters

Parameter	Type
endpoint	T

Returns

T

Example

import { defineEndpoint } from 'sorbus';
import { z } from 'zod';

const show = defineEndpoint({
  method: 'GET',
  path: '/invoices/:id',
  pathParams: z.object({
    id: z.string(),
  }),
  response: {
    body: z.object({
      invoice: z.object({
        id: z.string(),
        number: z.string(),
      }),
    }),
  },
});