mini-effect
    Preparing search index...

    Interface ExamplesAction<TInput$1, TExamples>

    Examples action interface.

    interface ExamplesAction<TInput$1, TExamples extends readonly TInput$1[]> {
        "~types"?: { input: TInput$1; issue: never; output: TInput$1 };
        examples: TExamples;
        kind: "metadata";
        reference: <TInput$1, const TExamples extends readonly TInput$1[]>(
            examples_: TExamples,
        ) => ExamplesAction<TInput$1, TExamples>;
        type: "examples";
    }

    Type Parameters

    • TInput$1
    • TExamples extends readonly TInput$1[]

    Hierarchy (View Summary)

    Index

    Properties

    ~types? examples kind reference type

    Properties

    "~types"?: { input: TInput$1; issue: never; output: TInput$1 }

    The input, output and issue type.

    examples: TExamples

    The examples.

    kind: "metadata"

    The object kind.

    reference: <TInput$1, const TExamples extends readonly TInput$1[]>(
        examples_: TExamples,
    ) => ExamplesAction<TInput$1, TExamples>

    The action reference.

    Type Declaration

      • <TInput$1, const TExamples extends readonly TInput$1[]>(
            examples_: TExamples,
        ): ExamplesAction<TInput$1, TExamples>
      • Beta

        Creates an examples metadata action.

        Type Parameters

        • TInput$1
        • const TExamples extends readonly TInput$1[]

        Parameters

        • examples_: TExamples

          The examples.

        Returns ExamplesAction<TInput$1, TExamples>

        An examples action.

    type: "examples"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties