Function: createSettingsPlugin()
Function: createSettingsPlugin()
Section titled “Function: createSettingsPlugin()”createSettingsPlugin<
TData>(data):ChoicekitPlugin<{api: {get: () =>ReadonlyDeep<ExpandType<TData>>;off: <TEventName>(eventName,listener) =>void;on: <TEventName>(eventName,listener) => () =>void;once: <TEventName>(eventName,listener) => () =>void;set: (producer,emitEvent?) =>void;save:Promise<void>; };config: {default:ExpandType; };dependencies: [];id:"settings";serializedState: {settings:ExpandType; };state: {eventEmitter:TypedEventEmitter<SettingsEvents<ExpandType<TData>>>;settings:ExpandType; }; }>
Defined in: plugins/examples/settings.ts:58
Type Parameters
Section titled “Type Parameters”TData extends GenericSerializableObject
Parameters
Section titled “Parameters”TData
Returns
Section titled “Returns”ChoicekitPlugin<{ api: { get: () => ReadonlyDeep<ExpandType<TData>>; off: <TEventName>(eventName, listener) => void; on: <TEventName>(eventName, listener) => () => void; once: <TEventName>(eventName, listener) => () => void; set: (producer, emitEvent?) => void; save: Promise<void>; }; config: { default: ExpandType; }; dependencies: []; id: "settings"; serializedState: { settings: ExpandType; }; state: { eventEmitter: TypedEventEmitter<SettingsEvents<ExpandType<TData>>>; settings: ExpandType; }; }>