Skip to content

Cerces


Cerces / parameters / Body

Function: Body()

Call Signature

Body(): BodyParameter<ZodString>

Defined in: src/parameters.ts:101

Returns

BodyParameter<ZodString>

Call Signature

Body(schema, options?): BodyParameter<ZodString>

Defined in: src/parameters.ts:102

Parameters

schema

StringConstructor

options?

mediaType?

string

description?

string

includeInSchema?

boolean

preprocessor?

Preprocessor

Returns

BodyParameter<ZodString>

Call Signature

Body(schema, options?): BodyParameter<ZodType<Blob, unknown, $ZodTypeInternals<Blob, unknown>>>

Defined in: src/parameters.ts:106

Parameters

schema

{(blobParts?, options?): Blob; prototype: Blob; }

prototype

Blob

options?

mediaType?

string

description?

string

includeInSchema?

boolean

preprocessor?

Preprocessor

Returns

BodyParameter<ZodType<Blob, unknown, $ZodTypeInternals<Blob, unknown>>>

Call Signature

Body(schema, options?): BodyParameter<ZodType<ReadableStream<any>, unknown, $ZodTypeInternals<ReadableStream<any>, unknown>>>

Defined in: src/parameters.ts:110

Parameters

schema

{(underlyingSource, strategy?): ReadableStream<Uint8Array<ArrayBuffer>>; <R>(underlyingSource, strategy?): ReadableStream<R>; <R>(underlyingSource?, strategy?): ReadableStream<R>; prototype: ReadableStream; }

prototype

ReadableStream

options?

mediaType?

string

description?

string

includeInSchema?

boolean

preprocessor?

Preprocessor

Returns

BodyParameter<ZodType<ReadableStream<any>, unknown, $ZodTypeInternals<ReadableStream<any>, unknown>>>

Call Signature

Body<S>(schema, options?): BodyParameter<S>

Defined in: src/parameters.ts:114

Type Parameters

S

S extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Parameters

schema

S

options?

description?

string

includeInSchema?

boolean

preprocessor?

Preprocessor

Returns

BodyParameter<S>