Workery / parameters

Module: parameters

Table of contents

Functions

• Path
• Query
• Header
• Cookie
• Body
• Depends
• parseArgs
• Responds

Functions

Path

▸ Path(): PathParameter<z.ZodString>

Returns

PathParameter<z.ZodString>

Defined in

src/parameters.ts:27

▸ Path<S>(schema, options?): PathParameter<S>

Type parameters

Name	Type
S	extends ZodType<any, ZodTypeDef, any>

Parameters

Name	Type
schema	S
options?	Omit<RouteParameterOptions, "mediaType">

Returns

PathParameter<S>

Defined in

src/parameters.ts:28

---

Query

▸ Query(): QueryParameter<z.ZodString>

Returns

QueryParameter<z.ZodString>

Defined in

src/parameters.ts:47

▸ Query<S>(schema, options?): QueryParameter<S>

Type parameters

Name	Type
S	extends ZodType<any, ZodTypeDef, any>

Parameters

Name	Type
schema	S
options?	Omit<RouteParameterOptions, "mediaType">

Returns

QueryParameter<S>

Defined in

src/parameters.ts:48

---

Header

▸ Header(): HeaderParameter<z.ZodString>

Returns

HeaderParameter<z.ZodString>

Defined in

src/parameters.ts:67

▸ Header<S>(schema, options?): HeaderParameter<S>

Type parameters

Name	Type
S	extends ZodType<any, ZodTypeDef, any>

Parameters

Name	Type
schema	S
options?	Omit<RouteParameterOptions, "mediaType">

Returns

HeaderParameter<S>

Defined in

src/parameters.ts:68

---

Cookie

▸ Cookie(): CookieParameter<z.ZodString>

Returns

CookieParameter<z.ZodString>

Defined in

src/parameters.ts:87

▸ Cookie<S>(schema, options?): CookieParameter<S>

Type parameters

Name	Type
S	extends ZodType<any, ZodTypeDef, any>

Parameters

Name	Type
schema	S
options?	Omit<RouteParameterOptions, "mediaType">

Returns

CookieParameter<S>

Defined in

src/parameters.ts:88

---

Body

▸ Body(): BodyParameter<z.ZodString>

Returns

BodyParameter<z.ZodString>

Defined in

src/parameters.ts:107

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

Parameters

Name	Type
schema	StringConstructor
options?	Omit<RouteParameterOptions, "altName">

Returns

BodyParameter<z.ZodString>

Defined in

src/parameters.ts:108

▸ Body(schema, options?): BodyParameter<z.ZodType<Blob>>

Parameters

Name	Type
schema	(blobParts?: BlobPart[], options?: BlobPropertyBag) => Blob
schema.prototype	Blob
options?	Omit<RouteParameterOptions, "altName">

Returns

BodyParameter<z.ZodType<Blob>>

Defined in

src/parameters.ts:112

▸ Body(schema, options?): BodyParameter<z.ZodType<ReadableStream>>

Parameters

Name	Type
schema	(underlyingSource: UnderlyingByteSource, strategy?: { highWaterMark?: number }) => ReadableStream<Uint8Array><R>(underlyingSource: UnderlyingDefaultSource<R>, strategy?: QueuingStrategy<R>) => ReadableStream<R><R>(underlyingSource?: UnderlyingSource<R>, strategy?: QueuingStrategy<R>) => ReadableStream<R>
schema.prototype	ReadableStream<any>
options?	Omit<RouteParameterOptions, "altName">

Returns

BodyParameter<z.ZodType<ReadableStream>>

Defined in

src/parameters.ts:116

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

Type parameters

Name	Type
S	extends ZodType<any, ZodTypeDef, any>

Parameters

Name	Type
schema	S
options?	Omit<RouteParameterOptions, "altName">

Returns

BodyParameter<S>

Defined in

src/parameters.ts:120

---

Depends

▸ Depends<R>(dependency): DependsParameter<z.ZodType<R>>

Type parameters

Name
R

Parameters

Name	Type
dependency	Dependency<R, any, any>

Returns

DependsParameter<z.ZodType<R>>

Defined in

src/parameters.ts:140

---

parseArgs

▸ parseArgs<Ps, E>(parameters, input): Promise<ParseArgsInfo<Ps, E>>

Type parameters

Name	Type
Ps	extends RouteParameters
E	unknown

Parameters

Name	Type
parameters	Ps
input	Object
input.baseArgs	ArgsOf<{}, E>
input.rawParameters?	Object
input.rawParameters.params?	Record<string, string>
input.rawParameters.queries?	Record<string, string[]>
input.rawParameters.cookies?	Record<string, string>
input.later	Later

Returns

Promise<ParseArgsInfo<Ps, E>>

Defined in

src/parameters.ts:148

---

Responds

▸ Responds(): ResponseConfig

Returns

ResponseConfig

Defined in

src/parameters.ts:250

▸ Responds(schema, options?): ResponseConfig

Parameters

Name	Type
schema	StringConstructor
options?	RespondsOptions

Returns

ResponseConfig

Defined in

src/parameters.ts:251

▸ Responds(schema, options?): ResponseConfig

Parameters

Name	Type
schema	(blobParts?: BlobPart[], options?: BlobPropertyBag) => Blob
schema.prototype	Blob
options?	RespondsOptions

Returns

ResponseConfig

Defined in

src/parameters.ts:252

▸ Responds(schema, options?): ResponseConfig

Parameters

Name	Type
schema	(underlyingSource: UnderlyingByteSource, strategy?: { highWaterMark?: number }) => ReadableStream<Uint8Array><R>(underlyingSource: UnderlyingDefaultSource<R>, strategy?: QueuingStrategy<R>) => ReadableStream<R><R>(underlyingSource?: UnderlyingSource<R>, strategy?: QueuingStrategy<R>) => ReadableStream<R>
schema.prototype	ReadableStream<any>
options?	RespondsOptions

Returns

ResponseConfig

Defined in

src/parameters.ts:253

▸ Responds(schema, options?): ResponseConfig

Parameters

Name	Type
schema	ZodType<any, ZodTypeDef, any>
options?	RespondsOptions

Returns

ResponseConfig

Defined in

src/parameters.ts:254