Class SideEffectManager

Hierarchy

SideEffectManager

Index

Constructors

constructor

new SideEffectManager(): SideEffectManager
Returns SideEffectManager

Properties

`Readonly` disposers

disposers: Map<string, SideEffectDisposer> = ...

All disposers. Use this only when you know what you are doing.

push

push: ((disposer: SideEffectDisposer | SideEffectDisposer[], disposerID?: string) => string) = ...

Type declaration

- (disposer: SideEffectDisposer | SideEffectDisposer[], disposerID?: string): string
- Alias
  addDisposer Add a disposer directly.
  
  Returns
  disposerID
  Parameters
  - disposer: SideEffectDisposer | SideEffectDisposer[]
    
    a disposer or a list of disposers
  - disposerID: string = ...
    
    Optional id for the disposer
  Returns string

Methods

add

add(executor: (() => null | false | SideEffectDisposer | SideEffectDisposer[]), disposerID?: string): string
Add a side effect.

Returns
disposerID
Parameters
- executor: (() => null | false | SideEffectDisposer | SideEffectDisposer[])
  
  Executes side effect. Return a disposer or a list of disposers. Returns null or false to ignore.
  - - (): null | false | SideEffectDisposer | SideEffectDisposer[]
    - Returns null | false | SideEffectDisposer | SideEffectDisposer[]
- disposerID: string = ...
  
  Optional id for the disposer
Returns string
- Defined in side-effect-manager.ts:40

addDisposer

addDisposer(disposer: SideEffectDisposer | SideEffectDisposer[], disposerID?: string): string
Add a disposer directly.

Returns
disposerID
Parameters
- disposer: SideEffectDisposer | SideEffectDisposer[]
  
  a disposer or a list of disposers
- disposerID: string = ...
  
  Optional id for the disposer
Returns string
- Defined in side-effect-manager.ts:13

addEventListener

addEventListener<K>(el: Window, type: K, listener: ((this: Window, ev: WindowEventMap[K]) => unknown), options?: boolean | AddEventListenerOptions, disposerID?: string): string
Sugar for addEventListener.

Returns
disposerID
Type Parameters
- K extends keyof WindowEventMap
Parameters
- el: Window
- type: K
- listener: ((this: Window, ev: WindowEventMap[K]) => unknown)
  - - (this: Window, ev: WindowEventMap[K]): unknown
    - Parameters
      
      this: Window
      
      ev: WindowEventMap[K]
      
      Returns unknown
- Optional options: boolean | AddEventListenerOptions
- Optional disposerID: string
  
  Optional id for the disposer
Returns string
- Defined in side-effect-manager.ts:57
addEventListener<K>(el: Document, type: K, listener: ((this: Document, ev: DocumentEventMap[K]) => unknown), options?: boolean | AddEventListenerOptions, disposerID?: string): string
Type Parameters
- K extends keyof DocumentEventMap
Parameters
- el: Document
- type: K
- listener: ((this: Document, ev: DocumentEventMap[K]) => unknown)
  - - (this: Document, ev: DocumentEventMap[K]): unknown
    - Parameters
      
      this: Document
      
      ev: DocumentEventMap[K]
      
      Returns unknown
- Optional options: boolean | AddEventListenerOptions
- Optional disposerID: string
Returns string
- Defined in side-effect-manager.ts:64
addEventListener<K>(el: HTMLElement, type: K, listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => unknown), options?: boolean | AddEventListenerOptions, disposerID?: string): string
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- el: HTMLElement
- type: K
- listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => unknown)
  - - (this: HTMLElement, ev: HTMLElementEventMap[K]): unknown
    - Parameters
      
      this: HTMLElement
      
      ev: HTMLElementEventMap[K]
      
      Returns unknown
- Optional options: boolean | AddEventListenerOptions
- Optional disposerID: string
Returns string
- Defined in side-effect-manager.ts:71
addEventListener<K>(el: MediaQueryList, type: K, listener: ((this: HTMLElement, ev: MediaQueryListEventMap[K]) => unknown), options?: boolean | AddEventListenerOptions, disposerID?: string): string
Type Parameters
- K extends "change"
Parameters
- el: MediaQueryList
- type: K
- listener: ((this: HTMLElement, ev: MediaQueryListEventMap[K]) => unknown)
  - - (this: HTMLElement, ev: MediaQueryListEventMap[K]): unknown
    - Parameters
      
      this: HTMLElement
      
      ev: MediaQueryListEventMap[K]
      
      Returns unknown
- Optional options: boolean | AddEventListenerOptions
- Optional disposerID: string
Returns string
- Defined in side-effect-manager.ts:78

flush

flush(disposerID: string): void
Remove and run the disposer. Do nothing if not found.
Parameters
- disposerID: string
Returns void
- Defined in side-effect-manager.ts:149

flushAll

flushAll(): void
Remove and run all of the disposers.

Returns void
- Defined in side-effect-manager.ts:159

genUID

genUID(): string
Returns string
- Defined in side-effect-manager.ts:169

remove

remove(disposerID: string): undefined | SideEffectDisposer
Remove but not run the disposer. Do nothing if not found.
Parameters
- disposerID: string
Returns undefined | SideEffectDisposer
- Defined in side-effect-manager.ts:139

setInterval

setInterval(handler: (() => void), timeout: number, disposerID?: string): string
Sugar for setInterval.

Returns
disposerID
Parameters
- handler: (() => void)
  - - (): void
    - Returns void
- timeout: number
- disposerID: string = ...
  
  Optional id for the disposer
Returns string
- Defined in side-effect-manager.ts:126

setTimeout

setTimeout(handler: (() => void), timeout: number, disposerID?: string): string
Sugar for setTimeout.

Returns
disposerID
Parameters
- handler: (() => void)
  - - (): void
    - Returns void
- timeout: number
- disposerID: string = ...
  
  Optional id for the disposer
Returns string
- Defined in side-effect-manager.ts:107

Class SideEffectManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SideEffectManager

Properties

Readonly disposers

push

Type declaration

Alias

Returns

Parameters

disposer: SideEffectDisposer | SideEffectDisposer[]

disposerID: string = ...

Returns string

Methods

add

Returns

Parameters

executor: (() => null | false | SideEffectDisposer | SideEffectDisposer[])

Returns null | false | SideEffectDisposer | SideEffectDisposer[]

disposerID: string = ...

Returns string

addDisposer

Returns

Parameters

disposer: SideEffectDisposer | SideEffectDisposer[]

disposerID: string = ...

Returns string

addEventListener

Returns

Type Parameters

K extends keyof WindowEventMap

Parameters

el: Window

type: K

listener: ((this: Window, ev: WindowEventMap[K]) => unknown)

Parameters

this: Window

ev: WindowEventMap[K]

Returns unknown

Optional options: boolean | AddEventListenerOptions

Optional disposerID: string

Returns string

Type Parameters

K extends keyof DocumentEventMap

Parameters

el: Document

type: K

listener: ((this: Document, ev: DocumentEventMap[K]) => unknown)

Parameters

this: Document

ev: DocumentEventMap[K]

Returns unknown

Optional options: boolean | AddEventListenerOptions

Optional disposerID: string

Returns string

Type Parameters

K extends keyof HTMLElementEventMap

Parameters

el: HTMLElement

type: K

listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => unknown)

Parameters

this: HTMLElement

ev: HTMLElementEventMap[K]

Returns unknown

Optional options: boolean | AddEventListenerOptions

Optional disposerID: string

Returns string

Type Parameters

K extends "change"

Parameters

el: MediaQueryList

type: K

listener: ((this: HTMLElement, ev: MediaQueryListEventMap[K]) => unknown)

`Readonly` disposers

`Optional` options: boolean | AddEventListenerOptions

`Optional` disposerID: string

`Optional` options: boolean | AddEventListenerOptions

`Optional` disposerID: string

`Optional` options: boolean | AddEventListenerOptions

`Optional` disposerID: string

`Optional` options: boolean | AddEventListenerOptions

`Optional` disposerID: string