prorm API Reference
    Preparing search index...

    Interface ExternalFieldMeta

    Resolved per-field metadata.

    interface ExternalFieldMeta {
        store: string;
        bucket?: string;
        contentType?: string;
        field: string;
        keyColumn: string;
        keyPrefix: string;
        encoding: ExternalEncoding;
    }

    Hierarchy (View Summary)

    Index
    store bucket? contentType? field keyColumn keyPrefix encoding
    store: string

    Name the store was registered under with prorm.registerStore().

    bucket?: string

    Bucket / container to store objects in. Falls back to the store's defaultBucket. Key-value stores fold this into the key as a prefix.

    contentType?: string

    Content type recorded on write, where the store supports it.

    field: string

    The model property (e.g. avatar).

    keyColumn: string

    Column holding the object key. Defaults to <field>Key (e.g. avatarKey). Registered automatically as a nullable STRING.

    keyPrefix: string

    Prefix for generated keys. Defaults to <field>/. Only used when a value is written to a field that has no key yet.

    encoding: ExternalEncoding

    How to materialize the payload on read:

    • buffer (default) — a Buffer, for binary data
    • utf8 — a string
    • json — parsed via JSON.parse, stringified on write

    Settings
    Member Visibility

    On This Page
    Properties