@audiotool/nexus - v0.0.12
    Preparing search index...

    Interface PrimitiveField<P, M>

    A field that contains a primitive value of type P.

    interface PrimitiveField<
        P extends PrimitiveType = PrimitiveType,
        M extends "mut" | "immut" = "mut" | "immut",
    > {
        location: NexusLocation;
        mutable: M extends "mut" ? true : false;
        get value(): P;
    }

    Type Parameters

    Implements

    Index

    Properties

    Accessors

    Properties

    location: NexusLocation

    The location of this field within the Nexus document.

    mutable: M extends "mut" ? true : false

    Whether the field is mutable. Updating immutable fields results in a transaction error.

    If the type fo the field is known at compile time, updating the field using the TransactionBuilder or listing to updates of the field using the NexusEventManager will result in type errors.

    Accessors