Scope

A boundary for effects and business logic.

Scope collects all subscriptions which are made by child entities and provides destroy() method to unsubscribe from them.

Hierarchy

• Destroyable
  • Scope

Index

Properties

• add
• atom
• createScope
• destroy
• effect
• onDestroy
• signal
• syncEffect

Properties

add

add: <T>(resource: T) => T

Registers an unsubscribable resource which will be called when destroy() is called

---

Type declaration

• • <T>(resource: T): T

  • Registers an unsubscribable resource which will be called when destroy() is called

    ---

    Type parameters

    • T: Destroyable | Unsubscribable

    Parameters

    • resource: T

    Returns T

atom

atom: AtomFn

Creates a new atom and registers it for later disposal

createScope

createScope: () => Scope

Creates a child scope

---

Type declaration

• • (): Scope

  • Creates a child scope

    ---

    Returns Scope

destroy

destroy: () => void

Overrides Destroyable.destroy

Destroys the scope

---

Type declaration

• • (): void

  • Destroys the scope

    ---

    Returns void

effect

effect: EffectFn

Creates a new effect and registers it for later disposal

onDestroy

onDestroy: (teardown: ScopeTeardown) => void

Registers a callback or unsubscribable resource which will be called when destroy() is called

---

Type declaration

• • (teardown: ScopeTeardown): void

  • Registers a callback or unsubscribable resource which will be called when destroy() is called

    ---

    Parameters

    • teardown: ScopeTeardown

    Returns void

signal

signal: SignalFn

Creates a new signal and registers it for later disposal

syncEffect

syncEffect: EffectFn

Creates a new sync effect and registers it for later disposal