mock-violentmonkey/dist/src/vm-functions/storage.d.ts

Mock violentmonkey's globals for testing userscripts

type SetValue = (key: string, value: any) => void;
/** Sets a key / value pair for current context to storage. */
declare const setValue: SetValue;
type GetValue = <TValue>(key: string, defaultValue?: TValue) => TValue;
/** Retrieves a value for current context from storage. */
declare const getValue: GetValue;
type DeleteValue = (key: string) => void;
/** Deletes an existing key / value pair for current context from storage. */
declare const deleteValue: DeleteValue;
type ListValues = () => string[];
/** Returns an array of keys of all available values within this context. */
declare const listValues: ListValues;
type AddValueChangeListenerCallback = (key: string, oldValue: any, newValue: any, remote: boolean) => void;
type AddValueChangeListener = (name: string, callback: AddValueChangeListenerCallback) => string;
/** Adds a change listener to the storage and returns the listener ID. */
declare const addValueChangeListener: AddValueChangeListener;
type RemoveValueChangeListener = (listenerId: string) => void;
/** Removes a change listener by its ID. */
declare const removeValueChangeListener: RemoveValueChangeListener;
/**
 * Use these in test files
 */
export { setValue as GM_setValue, getValue as GM_getValue, deleteValue as GM_deleteValue, listValues as GM_listValues, addValueChangeListener as GM_addValueChangeListener, removeValueChangeListener as GM_removeValueChangeListener, type SetValue, type GetValue, type DeleteValue, type ListValues, type AddValueChangeListener, type AddValueChangeListenerCallback, type RemoveValueChangeListener, };