Job Components: `Index Event Loop`
index.EventLoop
A simple class for detecting when the event loop is blocked.
The recommend use is to call EventLoop.init(logger)
and then
await EventLoop.wait()
where you want to slow down potentially
long running synchronous code
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new EventLoop(logger
): EventLoop
Parameters
Name | Type |
---|---|
logger | Logger |
Returns
Defined in
packages/utils/dist/src/event-loop.d.ts:26
Properties
checkedInDiff
• checkedInDiff: number
Defined in
packages/utils/dist/src/event-loop.d.ts:22
logger
• Readonly
logger: Logger
Defined in
packages/utils/dist/src/event-loop.d.ts:9
DEFAULT_HEARTBEAT
▪ Static
DEFAULT_HEARTBEAT: number
Defined in
packages/utils/dist/src/event-loop.d.ts:10
Accessors
blocked
• get
blocked(): boolean
Returns
boolean
Defined in
packages/utils/dist/src/event-loop.d.ts:27
Methods
cancel
▸ cancel(): void
Cancel the event loop checker
Returns
void
Defined in
packages/utils/dist/src/event-loop.d.ts:31
init
▸ init(logger
): EventLoop
Creates or replaces an instead of a global EvenLoop
Parameters
Name | Type |
---|---|
logger | Logger |
Returns
Defined in
packages/utils/dist/src/event-loop.d.ts:21
wait
▸ wait(): void
| Promise
<void
>
Adds a setTimeout if the event loop is blocked and will the delay will get slower the longer the event loop is block (with an upper limit)
Returns
void
| Promise
<void
>
Defined in
packages/utils/dist/src/event-loop.d.ts:16