Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClosePreventionSystem

collboard-system

Hierarchy

  • AbstractSystem
    • ClosePreventionSystem

Implements

  • IClosePreventionSystem
  • IClosePreventable
  • IDestroyable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • systems: ISystemsExtended

    Returns ClosePreventionSystem

Properties

Private beforeunloadHandler

beforeunloadHandler: any

Readonly ready

ready: Promise<void>

Promise which is resolved when the system is initialized and ready to use.

Private reasons

reasons: any

Protected Readonly systems

systems: ISystemsExtended

Accessors

canBeClosed

  • get canBeClosed(): boolean

  • Returns boolean

isDestroyed

  • get isDestroyed(): boolean

  • Is this object destroyed?

    Returns boolean

isReady

  • get isReady(): boolean

  • Checks if the system is initialized and ready to use.

    Returns boolean

Methods

addSubdestroyable

  • Binds new registration with itself. This registration/destroyable will be destroyed with this.

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns ClosePreventionSystem

Protected checkIsReady

  • checkIsReady(): void

  • Checks if the system is initialized and ready to use. If not, throws an error. If it is, do nothing.

    Returns void

Protected checkWhetherNotDestroyed

  • checkWhetherNotDestroyed(errorMessage?: string, runBeforeError?: () => void): void

  • Checks, whether the object is not destroyed

    Parameters

    • Optional errorMessage: string

      Message that will replace default one before error

    • Optional runBeforeError: () => void

      Callback runed before error is thrown; typically this can be some logging

        • (): void

        • Returns void

    Returns void

destroy

  • destroy(): Promise<void>

  • Returns Promise<void>

Protected init

  • init(): Promise<void>

  • Returns Promise<void>

registerClosePrevention

  • registerClosePrevention(...reasons: IClosePreventable[]): Registration

  • Parameters

    • Rest ...reasons: IClosePreventable[]

    Returns Registration

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable