SDK y paquetes@styx/api-contractsindexfunctions

Function: compileContract()

Referencia de @styx/api-contracts generada de su TSDoc.

ImplementadoSin versión del tren todavía· generada desde packages/api-contracts/package.json

Página generada desde el TSDoc de @styx/api-contracts. No se edita a mano: bun run docs:gen la regenera y bun run docs:check falla si difiere.

Function: compileContract()

compileContract<T>(schema): IContractValidator<T>

Devuelve el validador (compilación memoizada por identidad de schema) de un contrato. Barato de llamar a nivel de módulo: no compila hasta el primer check.

Type Parameters

T

T extends TSchema

Parameters

schema

T

Schema TypeBox crudo exportado por el contrato.

Returns

IContractValidator<T>

Validador perezoso.

Example

const getAsset = compileContract(GetAssetQueryPayloadSchema);
const parsed = getAsset.validate(env.payload, 'getAsset payload');
if (isErr(parsed)) return reply(parsed.error);