Type alias Storage

Storage: {
    clear: (() => void);
    debug: boolean;
    get: ((callback?) => void);
    getAsync: (() => Promise<unknown | null>);
    key: string;
    set: ((data, callback?) => void);
    setAsync: ((data) => Promise<void>);
    store: LocalForage;
    version: number;
}

Storage class for Editor.

Type declaration

  • clear: (() => void)
      • (): void

      • Clears all items from the storage.

        This method removes all key-value pairs from the storage, effectively resetting it to an empty state.

        Returns void

  • debug: boolean

    Whether debugging is enabled.

    Default

    false
  • get: ((callback?) => void)
      • (callback?): void

      • Retrieves data from the storage and optionally executes a callback with the retrieved data.

        Parameters

        • Optional callback: ((data) => void)

          An optional callback function that will be called with the retrieved data.

            • (data): void

            • Parameters

              • data: unknown

              Returns void

        Returns void

        Remarks

        This method measures the time taken to load the state from IndexedDB and logs it if debugging is enabled.

  • getAsync: (() => Promise<unknown | null>)
      • (): Promise<unknown | null>

      • Retrieves an item from the storage asynchronously.

        Returns Promise<unknown | null>

        A promise that resolves to the item retrieved from the storage, or null if the item does not exist.

  • key: string

    Key for the storage.

    Default

    'state'
  • set: ((data, callback?) => void)
      • (data, callback?): void

      • Stores the provided data in IndexedDB and optionally executes a callback function.

        Parameters

        • data: any

          The data to be stored.

        • Optional callback: (() => void)

          An optional callback function to be executed after the data is stored.

            • (): void

            • Returns void

        Returns void

  • setAsync: ((data) => Promise<void>)
      • (data): Promise<void>

      • Asynchronously sets the provided data in the storage.

        Parameters

        • data: any

          The data to be stored.

        Returns Promise<void>

        A promise that resolves when the data has been stored.

        Remarks

        This method measures the time taken to store the data and logs it to the console if debugging is enabled.

  • store: LocalForage

    LocalForage instance for the storage.

  • version: number

    Version of the storage.

    Default

    1

Settings

Member Visibility

Theme

Generated using TypeDoc