Interface Config<S>
childDebounce?: number;
crudDispatch?: CrudDispatch<ExtractDataType<S>>;
dataReducer?: boolean;
defaultData?: ExtractDataType<S>[];
extraData?: { [key: string]: any };
gameSettings?: TJSGameSettings;
key: string;
manualUpdate?: boolean;
namespace: string;
scope: string;
StoreClass: new (...args: any[]) => S;
}
Type Parameters
- S extends BaseObjectEntryStore<any>
Hierarchy
- CrudArrayObjectStore.Options.Config<S>
- Config (View Summary)
Properties
OptionalchildDebounce
An integer between and including 0 - 1000; a debounce time in milliseconds for child store subscriptions to
invoke ArrayObjectStore.updateSubscribers notifying subscribers to this array store. Default
value: 250.
OptionalcrudDispatch
Optional dispatch function to receive C(R)UD updates on create, update, delete actions.
OptionaldataReducer
When true a DynArrayReducer will be instantiated wrapping store data and accessible from
ArrayObjectStore.dataReducer; default value: false.
OptionaldefaultData
When an instance of TJSGameSettings is defined and automatic game setting registered you may provide default data for the Foundry game setting.
OptionalextraData
Optional additional data that is dispatched with CrudDispatch callbacks.
OptionalgameSettings
An instance of TJSGameSettings. If provided a user game setting will be automatically registered
for the given namespace,key, and scope with this instance as the associated game setting store.
key
Game setting key field.
OptionalmanualUpdate
When true ArrayObjectStore.updateSubscribers must be invoked with a single boolean parameter for
subscribers to be updated; default value: false.
namespace
Game setting namespace field.
scope
Game setting scope field. Must be world or user. For GM only modification w/ readability by all users
choose world. For unique user private data that can be read / write by a single user choose user.
StoreClass
The entry store class that is instantiated.
Store type.