Documentation
    Preparing search index...

    Interface IData<T>

    Internal storage shape for SwaggerExample metadata.

    Reflects the OpenAPI spec's two example fields: a single default example, and/or a named map examples. index is used internally to associate parameter examples with the right parameter position.

    contracts/common.md#principled-implementation The record holds the single example, the named examples, and the parameter index, which is everything the generator needs to attach examples.

    contracts/common.md#clear-and-simple-design A flat record whose members are all optional.

    contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.

    contracts/common.md#meaningful-documentation The comment states the meaning of the members.

    contracts/portability.md#os-neutral-implementation Example metadata contains caller values and parameter indices without a native path or process boundary.

    interface IData<T> {
        example?: T;
        examples?: Record<string, T>;
        index?: number;
    }

    Type Parameters

    • T
    Index
    example?: T
    examples?: Record<string, T>
    index?: number