prorm API Reference
    Preparing search index...

    Class ImmutableRecord

    Index
    constructor
    makeImmutable enableVersioning isImmutable hasVersioning getVersionConfig listImmutableModels
    makeImmutable: (Model: any, options?: ImmutableOptions) => void = makeImmutable

    Type Declaration

      • (Model: any, options?: ImmutableOptions): void

      • Mark a model as immutable — blocks UPDATE and DELETE.

        Parameters

        • Model: any

          The model class to protect

        • options: ImmutableOptions = {}

          Immutable configuration options

        Returns void

    enableVersioning: (Model: any, options?: VersionOptions) => void = enableVersioning

    Type Declaration

      • (Model: any, options?: VersionOptions): void

      • Enable soft versioning on an immutable model. Adds version and previousId fields, and auto-increments on append.

        Parameters

        • Model: any

          The model class

        • options: VersionOptions = {}

          Version field configuration

        Returns void

    isImmutable: (Model: any) => boolean = isImmutable

    Type Declaration

      • (Model: any): boolean

      • Check if a model is configured as immutable.

        Parameters

        • Model: any

        Returns boolean

    hasVersioning: (Model: any) => boolean = hasVersioning

    Type Declaration

      • (Model: any): boolean

      • Check if an immutable model has versioning enabled.

        Parameters

        • Model: any

        Returns boolean

    getVersionConfig: (Model: any) => Required<VersionOptions> | undefined = getVersionConfig

    Type Declaration

      • (Model: any): Required<VersionOptions> | undefined

      • Get the version configuration for an immutable model.

        Parameters

        • Model: any

        Returns Required<VersionOptions> | undefined

    listImmutableModels: () => { model: any; options: ImmutableOptions }[] = listImmutableModels

    Type Declaration

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties