Options
All
  • Public
  • Public/Protected
  • All
Menu

Use this class as main entry for your unblocking mechanism.

Attention: Please make sure you start the watcher at time where the document.readyState is not already complete. Why? At this time, we can make sure that our jQuery.fn.ready and other initiators works as expected.

Type parameters

Hierarchy

  • UnblockWatcher

Index

Constructors

constructor

  • Parameters

    Returns UnblockWatcher

Properties

Private interval

interval: ReturnType<typeof setInterval>

Private options

options: FindAndUnblockOptions<ExtendedBlockerDefinition>

Private startTimeout

startTimeout: ReturnType<typeof setTimeout>

Methods

setMode

  • setMode(mode: UnblockWatcher["options"]["mode"]): void
  • Parameters

    • mode: UnblockWatcher["options"]["mode"]

    Returns void

start

  • start(mode?: UnblockWatcher["options"]["mode"]): void
  • Parameters

    • Default value mode: UnblockWatcher["options"]["mode"] = "unblock"

    Returns void

stop

  • stop(): void
  • Returns void

unblockNow

  • unblockNow(): Promise<void>
  • Returns Promise<void>

Generated using TypeDoc