SheetXL - v1.0.2
    Preparing search index...

    Class RichRecord

    A value of a kind with no code of its own: a record of properties its kind declares, such as an entity read from a file (a stock, a country).

    It reads as nothing where a primitive is consumed and shows its kind's display property. A property it holds no value for reads as the kind's default. Its presentation per property is its own where it differs from its kind's (getPropertyMeta).

    Immutable. Make its kind with RichRecord.defineKind.

    Implements

    • IRichData
    Index
    • Parameters

      • kind: IRichDataKind<RichRecord>

        The record's kind, from RichRecord.defineKind.

      • values: Readonly<Record<string, Scalar>>

        The values it holds, by property name.

      • Optionalmeta: Readonly<Record<string, IRichMeta>> | null

        Presentation for the properties where it differs from its kind, by property name.

      Returns RichRecord

    • get isIRichData(): true

      {@inheritDoc IRichData.isIRichData}

      Returns true

    • {@inheritDoc IRichData.getKind}

      Returns IRichType

    • The presentation the record gives its own properties, by property name, or null.

      Returns Readonly<Record<string, IRichMeta>> | null

    • {@inheritDoc IRichData.getProperty}

      Parameters

      • name: string

      Returns Scalar

    • {@inheritDoc IRichData.getPropertyMeta}

      Parameters

      • name: string

      Returns IRichMeta | null

    • The values the record holds, by property name: not its kind's defaults.

      Returns Readonly<Record<string, Scalar>>

    • {@inheritDoc IRichData.toJSON}

      Parameters

      • OptionaltoResourceId: ToResourceId

      Returns JSON

    • {@inheritDoc IRichData.toString}

      Returns string