ApiOperation
interfaz
Declaración de tipos de una operación de API, que el contrato generado infiere de los schemas
públicos de shared/. undefined en un campo indica que la operación no lo acepta.
ts
import type { ApiOperation } from "@meekojs/meeko/framework";Source code src/shared/clients.ts:112
Declaración #
ts
interface ApiOperation<Params = undefined, Query = undefined, Body = undefined, Output = unknown> {
readonly params: Params
readonly query: Query
readonly body: Body
readonly output: Output
}Type parameters #
-
Params= undefined -
Query= undefined -
Body= undefined -
Output= unknown
Example #
ts
import { createApiClient } from "@meekojs/meeko/framework";
import type { ApiOperation } from "@meekojs/meeko/framework";
type GetUser = ApiOperation<{ id: string }, undefined, undefined, { id: string; name: string }>;
const api = createApiClient<{ "users.byId": { get: GetUser } }>({
api: [{ clientKey: "users.byId", pathname: "/api/users/[id]", method: "GET" }],
});
const user = await api.users({ id: "123" }).get();