Coda by Ian Macalinao
    Preparing search index...

    Interface InstructionArgumentNode<TDefaultValue, TType, TDisplay>

    A named argument of an instruction, with its type and an optional default value. Serialised next to each other, the arguments of an instruction form its data.

    Diagram

    interface InstructionArgumentNode<
        TDefaultValue extends
            InstructionInputValueNode
            | undefined = InstructionInputValueNode | undefined,
        TType extends TypeNode = TypeNode,
        TDisplay extends
            StructFieldDisplayNode | undefined = StructFieldDisplayNode | undefined,
    > {
        defaultValue?: TDefaultValue;
        defaultValueStrategy?: DefaultValueStrategy;
        display?: TDisplay;
        docs?: Docs;
        kind: "instructionArgumentNode";
        name: CamelCaseString;
        type: TType;
    }

    Type Parameters

    Index
    defaultValue? defaultValueStrategy? display? docs? kind name type
    defaultValue?: TDefaultValue

    A default value used when the argument is omitted by callers.

    defaultValueStrategy?: DefaultValueStrategy

    How a configured default value is exposed in generated APIs. Only relevant when defaultValue is set; when absent, optional is assumed.

    display?: TDisplay

    Display metadata describing how the argument is presented.

    docs?: Docs

    Markdown documentation for the argument.

    kind: "instructionArgumentNode"
    name: CamelCaseString

    The name of the argument.

    type: TType

    The type of the argument.

    Settings
    Member Visibility

    On This Page
    Properties