tsoa-next / @tsoa-next/runtime / Example

Function: Example()

function Example<T>(exampleModel, exampleLabel?): PropertyDecorator;

Defined in: packages/runtime/src/decorators/example.ts:7

Attaches an example value to a model property.

Type Parameters

T

T

Parameters

exampleModel

T

The example value to include in generated schema metadata.

exampleLabel?

string

Optional label used when multiple examples are present.

Returns

PropertyDecorator