Documentation
    Preparing search index...

    Metadata for a single function parameter.

    Describes a function parameter including its name, type schema, whether it's required, and any JSDoc documentation.

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

    Type Parameters

    Index

    Properties

    description?: string

    Parameter description from documentation.

    Full description of the parameter's purpose and usage, extracted from the @param JSDoc tag.

    name: string

    Parameter name.

    The identifier used in the function signature. Must match the actual parameter name in the source code.

    required: boolean

    Whether the parameter is required.

    true if the parameter must be provided, false if it has a default value or is explicitly optional.

    schema: Schema

    JSON Schema for the parameter type.

    Complete schema definition describing the expected parameter type, including constraints and nested structures.

    title?: string

    Parameter title for documentation.

    Brief name for the parameter, typically extracted from @param tag title in JSDoc.