Skip to content

basalt / sdk/src / endpoint

Function: endpoint() ​

> endpoint<B, Q, P, R>(spec): Endpoint<B, Q, P, R>

Defined in: sdk/src/endpoint.ts:30

endpoint({ method: 'POST', path: '/projects', body: z.object({ name: z.string() }), result: ProjectSchema })

Type Parameters ​

B ​

B extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> | undefined = undefined

Q ​

Q extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> | undefined = undefined

P ​

P extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> | undefined = undefined

R ​

R extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> | undefined = undefined

Parameters ​

spec ​

body? ​

B

method ​

HttpMethod

params? ​

P

path ​

string

query? ​

Q

result? ​

R

Returns ​

Endpoint<B, Q, P, R>

Released under the MIT License.