prorm API Reference
    Preparing search index...

    Interface WORMOptions

    WORM configuration options

    interface WORMOptions {
        retentionPeriod: RetentionDuration;
        tamperEvident?: boolean;
        tableName?: string;
        stateField?: string;
        timestampField?: string;
        allowSoftDelete?: boolean;
        autoArchive?: boolean;
        autoFreeze?: boolean;
        integrateWithRetention?: boolean;
    }
    Index
    retentionPeriod tamperEvident? tableName? stateField? timestampField? allowSoftDelete? autoArchive? autoFreeze? integrateWithRetention?
    retentionPeriod: RetentionDuration

    Retention period for the records

    tamperEvident?: boolean

    Enable tamper-evident audit trail. Default: true

    tableName?: string

    Custom table name for WORM metadata. Default: 'WORMMetadata'

    stateField?: string

    State field name. Default: 'wormState'

    timestampField?: string

    Timestamp field for archive. Default: 'archivedAt'

    allowSoftDelete?: boolean

    Allow soft deletes instead of hard blocks. Default: false

    autoArchive?: boolean

    Automatically archive after creation. Default: false

    autoFreeze?: boolean

    Auto-freeze after retention period. Default: false

    integrateWithRetention?: boolean

    Integrate with DataRetentionPolicy. Default: true

    Settings
    Member Visibility

    On This Page
    Properties