Interface SubscriptionManager<T>

Typeparam

T - data that will be passed to the function when notified

Type Parameters

T = unknown

Hierarchy

SubscriptionManager

Index

Methods

notify subscribe useSubscribeEffect

Methods

notify

notify(data?: T): void
Notify subscribers.
Parameters
- Optional data: T
  
  optionally pass data to the subscribers.
Returns void
- Defined in src/useSubscription/SubscriptionManager.ts:15

subscribe

subscribe(callback: ((data: T) => void)): (() => void)
Returns
unsubscribe callback.
Parameters
- callback: ((data: T) => void)
  
  function to call when notified. It can be passed some data
  - - (data: T): void
    - Parameters
      
      data: T
      
      Returns void
Returns (() => void)
- - (): void
  - Returns
    unsubscribe callback.
    
    Returns void
- Defined in src/useSubscription/SubscriptionManager.ts:10

useSubscribeEffect

useSubscribeEffect(callback: ((data: T) => void)): void
a hook that subscribes from the current subscription.
Parameters
- callback: ((data: T) => void)
  
  callback
  - - (data: T): void
    - Parameters
      
      data: T
      
      Returns void
Returns void
- Defined in src/useSubscription/SubscriptionManager.ts:21

Generated using TypeDoc