Interface StructFieldTypeNode<TType, TDefaultValue, TDisplay>

A named field within a struct type.

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

Type Parameters

TType extends TypeNode = TypeNode
TDefaultValue extends ValueNode | undefined = ValueNode | undefined
TDisplay extends StructFieldDisplayNode | undefined = StructFieldDisplayNode | undefined

Index

Properties

defaultValue? defaultValueStrategy? display? docs? kind name type

Properties

`Optional` `Readonly`defaultValue

defaultValue?: TDefaultValue

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

`Optional` `Readonly`defaultValueStrategy

defaultValueStrategy?: DefaultValueStrategy

How a configured default value is exposed in generated APIs. Required when defaultValue is set.

`Optional` `Readonly`display

display?: TDisplay

Display metadata describing how the field is presented.

`Optional` `Readonly`docs

docs?: Docs

Markdown documentation for the field.

`Readonly`kind

kind: "structFieldTypeNode"

`Readonly`name

name: CamelCaseString

The name of the field.

`Readonly`type

type: TType

The type of the field.