SheetXL - v0.3.20
    Preparing search index...

    Interface StoreOperationOptions<VIEW, PARAMS>

    Options for operations with the store.

    interface StoreOperationOptions<VIEW = any, PARAMS = any> {
        autoSelect?: boolean | ITypes.SelectOptions;
        description?: string;
        forceAmend?: boolean;
        meta?: Record<string, string>;
        operation?: Operation<PARAMS>;
        preventFurtherTransactions?: boolean;
    }

    Type Parameters

    • VIEW = any
    • PARAMS = any

    Hierarchy (View Summary)

    Index

    Properties

    autoSelect? description? forceAmend? meta? operation? preventFurtherTransactions?

    Properties

    autoSelect?: boolean | ITypes.SelectOptions

    If true or set then this will select the affect item after the transaction is complete.

    If this is set to true then any restore will also select.

    description?: string

    A human description.

    'determined by the set operation and locale'
    forceAmend?: boolean

    If set to true, The commit will not create a new snapshot but instead merge with the existing.

    false
    • Ths is used for internal listeners and historical corrections.
    • This is only read for the top transaction.
    • This should generally be avoided as the audits and history are lost.
    meta?: Record<string, string>

    Stored with the commit.

    operation?: Operation<PARAMS>

    Used to record audit points.

    preventFurtherTransactions?: boolean

    If set to true, prevents further transactions from being pushed onto the stack until the current transaction is complete. Once the current transaction is either committed or rolled back, this restriction is automatically lifted.

    false

    Settings

    Member Visibility

    On This Page

    Properties