The constructor interface of the document update handler.

Hierarchy

  • DocumentUpdateHandlerConstructor

Constructors

Constructors

  • Creates a new document update handler.

    Parameters

    • total: number

      The total number of steps to be completed.

    • callback: (() => void)

      The callback function to be called once all steps are completed.

        • (): void
        • Returns void

    • Optional skipRefresh: boolean

      If set to true, the document will not be refreshed once all steps are completed. Defaults to false, meaning by default the document will be refreshed.

    • Optional skipUpdatePreview: boolean

      If set to true, the page thumbnails will not be updated once all steps are completed. Defaults to false, meaning by default the page thumbnails will be updated.

    Returns DocumentUpdateHandler

    A new update handler.

Generated using TypeDoc