Member Junction
    Preparing search index...

    Class JsonWriteHelper

    Helper class for writing JSON files for RecordData objects. Preserves the caller's key order, recursing into known keys (fields, relatedEntities, primaryKey, sync, etc.).

    Index

    Constructors

    constructor

    Methods

    createOrderedRecordData writeJson writeOrderedRecordData

    Constructors

    Methods

    • Create a RecordData object with explicit property ordering for consistent JSON output

      Parameters

      • fields: Record<string, unknown>

        Entity field data

      • relatedEntities: Record<string, RecordData[]>

        Related entity data

      • primaryKey: Record<string, unknown>

        Primary key data

      • sync: { checksum: string; lastModified: string }

        Sync metadata

      • Optionalcollections: Record<string, RecordData[]>

        First-class collections data

      • Optionalembeds: Record<string, RecordData>

        First-class embeds data

      • Optionalextension:
            | { entity?: string; fields: Record<string, unknown> }
            | Record<string, { fields: Record<string, unknown> }>

        First-class extension data

      • Optionalschema: string

        Optional $schema URI

      Returns RecordData

      RecordData object with guaranteed property order

    • Write regular JSON data (non-RecordData) with standard formatting

      Parameters

      • filePath: string

        Path to the JSON file to write

      • data: unknown

        Any JSON-serializable data

      • Optionaloptions: JFWriteOptions

        Optional JSON write options

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods