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

    Interface WriteEvent

    Fired after a workbook has been successfully written via IWorkbookIO.write.

    Not fired by IWorkbookIO.writeArrayBuffer (a raw encode, used for exports / uploads) or by a cancelled write.

    interface WriteEvent {
        commitId: string | null;
        origin: IWorkbookIO.Origin;
        save: boolean;
        workbook: IWorkbook;
    }

    Hierarchy (View Summary)

    Index
    commitId: string | null

    The workbook's transaction commit id at the moment its bytes were encoded.

    An opaque token identifying the persisted state. Pass it to TransactionSaveStateManager.markSaved so the workbook is marked clean as of exactly that state — edits made during the (async) write correctly remain unsaved.

    The IWorkbookIO.Origin handle the operation actually used — the file read, or the file written: the workbook's own origin for a plain save, a new one for a save that resolved a destination (a first save, a Save As), the target for an export. Its format is the one read or written.

    Uniform across read and write, so an ambient listener (e.g. recent-files) can track "the handle just touched" without branching on the event kind.

    save: boolean

    true when the write was a save (to the workbook's own origin); false for an explicit-target export (a copy). Only saves mark the workbook clean — see IWorkbookIO.addCommitListener.

    workbook: IWorkbook

    The workbook that was read or written. A listener filters on this to react to a specific workbook (the service is shared across all of them).