SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface IBackingStore

    A destination (and, optionally, source) for persisting workbooks — for example the local file system, a browser download, a VSCode host, or a cloud service.

    The active store is used by IWorkbookIO.write and can be replaced via IWorkbookIO.setBackingStore. A store is conceptually stateless from the caller's point of view; any session state it keeps (such as a browser FileSystemFileHandle for silent re-save) is a private implementation detail and never appears in these types.

    interface IBackingStore {
        read?(request: ReadRequest): Promise<IWorkbook | null>;
        write?(request: WriteRequest): Promise<IWorkbookIO.Origin | null>;
    }

    Implemented by

    Index
    • Acquires bytes for a workbook and decodes them (via ReadRequest.decode).

      Parameters

      Returns Promise<IWorkbook | null>

      The decoded workbook, or null if the store could not produce one (e.g. the user cancelled an open picker, or the store does not recognize the source).

      Optional. IWorkbookIO.read uses the active store's read when present, and otherwise falls back to the built-in platform store — so a store that only overrides write still gets the default read behavior.