covenix / ParamMetadata

Interface: ParamMetadata

Defined in: src/metadata.ts:142

Metadata for one injected handler parameter, as returned by getParams.

Properties

file?

optional file?: "single" | "multiple"

Defined in: src/metadata.ts:155

For body-sourced file injectors: 'single' (from @File, expects a z.file() field) or 'multiple' (from @Files, expects a z.array(z.file()) field). Absent for @BodyParam. Lets registration-time validation check the injector against the @Body schema's shape.

---

index

index: number

Defined in: src/metadata.ts:144

Zero-based position in the handler's parameter list.

---

name?

optional name?: string

Defined in: src/metadata.ts:148

Key name for param/query/header sources; absent otherwise.

---

resolve?

optional resolve?: ParamResolver

Defined in: src/metadata.ts:157

Resolver for a custom source (from createParamDecorator); absent otherwise.

---

source

source: ParamSource

Defined in: src/metadata.ts:146

Request location the value is read from.