mobx-keystone/src/action/protection.ts

A MobX powered state management solution based on data trees with first class support for TypeScript, snapshots, patches and much more

import { failure } from "../utils"
import { getCurrentActionContext } from "./context"

function canWrite(): boolean {
  return !getActionProtection() || !!getCurrentActionContext()
}

/**
 * @internal
 */
export function assertCanWrite() {
  if (!canWrite()) {
    throw failure("data changes must be performed inside model actions")
  }
}

let actionProtection = true

/**
 * @internal
 *
 * Gets if the action protection is currently enabled or not.
 *
 * @returns
 */
export function getActionProtection() {
  return actionProtection
}

/**
 * @internal
 *
 * Sets if the action protection is currently enabled or not.
 */
export function setActionProtection(protection: boolean) {
  actionProtection = protection
}