@suluk/stubgen - v0.1.0
    Preparing search index...

    Interface StubGap

    The input: a gap the contract cannot back, optionally with the Examples columns that hint the request shape.

    interface StubGap {
        intent: string;
        fields?: { name: string; sample?: string }[];
        name?: string;
        method?: string;
        path?: string;
    }
    Index

    Properties

    intent fields? name? method? path?

    Properties

    intent: string

    the authored intent — the When step text, e.g. "I refund a charge".

    fields?: { name: string; sample?: string }[]

    the Examples columns (request field names) + an optional sample cell for type inference.

    name?: string

    explicit overrides (else inferred from intent).

    method?: string
    path?: string

    Settings

    Member Visibility

    On This Page

    Properties