Interface IOutput<Schema>

Metadata for function return type.

Describes the return type of a function including its schema, whether a value is always returned, and documentation.

interface IOutput<
    Schema extends
        OpenApi.IJsonSchema
        | OpenApiV3.IJsonSchema = OpenApi.IJsonSchema,
> {
    description?: string;
    required: boolean;
    schema: Schema;
}

Schema extends OpenApi.IJsonSchema | OpenApiV3.IJsonSchema = OpenApi.IJsonSchema
JSON schema type based on OpenAPI version

Properties

description?: string

Return value description from documentation.

Explanation of what the function returns, extracted from the @returns or @return JSDoc tag.

required: boolean

Whether a value is always returned.

true if the function always returns a value, false if it may return undefined or has a void return type.

schema: Schema

JSON Schema for the return type.

Complete schema definition describing the return value type, including constraints and nested structures.