Type alias ApplySnapshotOptions

ApplySnapshotOptions: {
    closeExistingWindows?: boolean;
    closeSnapshotWindows?: boolean;
    skipOutOfBoundsCheck?: boolean;
}

Type declaration

  • Optional closeExistingWindows?: boolean

    Default Value

    false

    When true, applySnapshot will close existing windows, replacing current Platform state with the given snapshot.

  • Optional closeSnapshotWindows?: boolean

    Default Value

    false

    When true, applySnapshot will close existing includeInSnapshots: true windows, replacing current Platform state with the given snapshot.

  • Optional skipOutOfBoundsCheck?: boolean

    Default Value

    false

    When true, applySnapshot will not check whether any windows in a snapshot are off-screen. By default, such windows will be repositioned to be on-screen, as defined by PlatformProvider.positionOutOfBoundsWindows.

Generated using TypeDoc