@resistdesign/voltra
    Preparing search index...

    Type Alias TypeInfoField

    Information about a field in a type definition.

    type TypeInfoField = {
        array: boolean;
        optional: boolean;
        possibleValues?: LiteralValue[];
        possibleValuesExhaustive?: boolean;
        readonly: boolean;
        tags?: SupportedFieldTags;
        type: TypeKeyword;
        typeReference?: string;
    }
    Index

    Properties

    array optional possibleValues? possibleValuesExhaustive? readonly tags? type typeReference?

    Properties

    array: boolean

    Whether the field is an array.

    optional: boolean

    Whether the field is optional.

    possibleValues?: LiteralValue[]

    Known literal values for the field.

    possibleValuesExhaustive?: boolean

    Whether possibleValues is exhaustive.

    Omitted values retain the existing strict-enum behavior. false indicates that the source union also contains the matching broad primitive, so the literals are metadata/suggestions rather than the complete set of valid primitive values.

    readonly: boolean

    Whether the field is read-only.

    tags?: SupportedFieldTags

    Optional field tags and constraints.

    type: TypeKeyword

    Scalar type keyword for the field.

    typeReference?: string

    Referenced TypeInfo type name, when relational.

    Settings

    Member Visibility

    On This Page

    Properties