mini-effect
    Preparing search index...

    Interface DescriptionAction<TInput$1, TDescription>

    Description action interface.

    interface DescriptionAction<TInput$1, TDescription extends string> {
        "~types"?: { input: TInput$1; issue: never; output: TInput$1 };
        description: TDescription;
        kind: "metadata";
        reference: <TInput$1, TDescription extends string>(
            description_: TDescription,
        ) => DescriptionAction<TInput$1, TDescription>;
        type: "description";
    }

    Type Parameters

    • TInput$1
    • TDescription extends string

    Hierarchy (View Summary)

    Index

    Properties

    ~types? description kind reference type

    Properties

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

    The input, output and issue type.

    description: TDescription

    The description text.

    kind: "metadata"

    The object kind.

    reference: <TInput$1, TDescription extends string>(
        description_: TDescription,
    ) => DescriptionAction<TInput$1, TDescription>

    The action reference.

    Type Declaration

      • <TInput$1, TDescription extends string>(
            description_: TDescription,
        ): DescriptionAction<TInput$1, TDescription>

      • Creates a description metadata action.

        Type Parameters

        • TInput$1
        • TDescription extends string

        Parameters

        • description_: TDescription

          The description text.

        Returns DescriptionAction<TInput$1, TDescription>

        A description action.

    type: "description"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties