mobx-bonsai
Version:
A fast lightweight alternative to MobX-State-Tree + Y.js two-way binding
31 lines (30 loc) • 969 B
TypeScript
import { NodeKeyGenerator } from './node/utils/nodeKeyGenerator';
/**
* Global config object.
*/
export interface GlobalConfig {
/**
* Node key generator function.
*/
keyGenerator: NodeKeyGenerator;
/**
* Whether to check for circular references when attaching nodes.
* When enabled, throws an error if a node would become an ancestor of itself.
* When disabled, circular references may cause infinite loops.
* For performance reasons this setting is disabled by default.
* Default: false
*/
checkCircularReferences: boolean;
}
/**
* Partially sets the current global config.
*
* @param config Partial object with the new configurations. Options not included in the object won't be changed.
*/
export declare function setGlobalConfig(config: Partial<GlobalConfig>): void;
/**
* Returns the current global config object.
*
* @returns
*/
export declare function getGlobalConfig(): Readonly<GlobalConfig>;