Variable onConst

Type Declaration

• • <
        E extends
            keyof EventMap<
                FetchEngine.InstanceState,
                FetchEngine.InstanceHeaders,
                FetchEngine.InstanceParams,
            >,
    >(
        event: E,
        options?: ListenerOptions,
    ): EventGenerator<
        EventMap<
            FetchEngine.InstanceState,
            FetchEngine.InstanceHeaders,
            FetchEngine.InstanceParams,
        >,
        E,
    >

  • Returns an event generator that will listen for the specified event

    Type Parameters

    • E extends keyof EventMap<
          FetchEngine.InstanceState,
          FetchEngine.InstanceHeaders,
          FetchEngine.InstanceParams,
      >

    Parameters

    • event: E
    • Optionaloptions: ListenerOptions

    Returns EventGenerator<
        EventMap<
            FetchEngine.InstanceState,
            FetchEngine.InstanceHeaders,
            FetchEngine.InstanceParams,
        >,
        E,
    >

    Example

    const obs = new ObserverEngine();
    
    const something = obs.on('something');
    const data = await something.next(); // waits for next event
    something.emit('special'); // emits data to listeners
    
    something.cleanup(); // stops listening for events
    Copy

  • <E extends string>(
        event: E,
        options?: ListenerOptions,
    ): EventGenerator<Record<E, any>>

  • Returns an event generator that will listen for the specified event

    Type Parameters

    • E extends string

    Parameters

    • event: E
    • Optionaloptions: ListenerOptions

    Returns EventGenerator<Record<E, any>>

    Example

    const obs = new ObserverEngine();
    
    const something = obs.on('something');
    const data = await something.next(); // waits for next event
    something.emit('special'); // emits data to listeners
    
    something.cleanup(); // stops listening for events
    Copy

  • <
        E extends
            keyof EventMap<
                FetchEngine.InstanceState,
                FetchEngine.InstanceHeaders,
                FetchEngine.InstanceParams,
            >,
    >(
        event: E,
        listener: EventCallback<
            EventMap<
                FetchEngine.InstanceState,
                FetchEngine.InstanceHeaders,
                FetchEngine.InstanceParams,
            >[E],
        >,
        options?: ListenerOptions,
    ): Cleanup

  • Listens for the specified event and executes the given callback

    Type Parameters

    • E extends keyof EventMap<
          FetchEngine.InstanceState,
          FetchEngine.InstanceHeaders,
          FetchEngine.InstanceParams,
      >

    Parameters

    • event: E
    • listener: EventCallback<
          EventMap<
              FetchEngine.InstanceState,
              FetchEngine.InstanceHeaders,
              FetchEngine.InstanceParams,
          >[E],
      >
    • Optionaloptions: ListenerOptions

    Returns Cleanup

    Example

    const obs = new ObserverEngine();
    
    obs.on('something', (data) => {
       console.log(data);
    });
    Copy

  • <E extends string>(
        event: E,
        listener: EventCallback<Record<E, any>>,
        options?: ListenerOptions,
    ): Cleanup

  • Returns an event generator that will listen for the specified event

    Type Parameters

    • E extends string

    Parameters

    • event: E
    • listener: EventCallback<Record<E, any>>
    • Optionaloptions: ListenerOptions

    Returns Cleanup

    Example

    const obs = new ObserverEngine();
    
    const something = obs.on('something');
    const data = await something.next(); // waits for next event
    something.emit('special'); // emits data to listeners
    
    something.cleanup(); // stops listening for events
    Copy

  • (
        event: RegExp,
        options?: ListenerOptions,
    ): EventGenerator<
        EventMap<
            FetchEngine.InstanceState,
            FetchEngine.InstanceHeaders,
            FetchEngine.InstanceParams,
        >,
        RegExp,
    >

  • Returns an event generator that will listen for all events matching the regex

    Parameters

    • event: RegExp
    • Optionaloptions: ListenerOptions

    Returns EventGenerator<
        EventMap<
            FetchEngine.InstanceState,
            FetchEngine.InstanceHeaders,
            FetchEngine.InstanceParams,
        >,
        RegExp,
    >

    Example

    const obs = new ObserverEngine();
    
    const onEvent = obs.on(/some/);
    const { event, data } = await onEvent.next(); // waits for next event
    onEvent.emit('something'); // emits data to listeners
    
    onEvent.cleanup(); // stops listening for events
    Copy

  • (
        event: RegExp,
        listener: EventCallback<
            RgxEmitData<
                EventMap<
                    FetchEngine.InstanceState,
                    FetchEngine.InstanceHeaders,
                    FetchEngine.InstanceParams,
                >,
            >,
        >,
        options?: ListenerOptions,
    ): Cleanup

  • Listens for all events matching the regex and executes the given callback

    Parameters

    • event: RegExp
    • listener: EventCallback<
          RgxEmitData<
              EventMap<
                  FetchEngine.InstanceState,
                  FetchEngine.InstanceHeaders,
                  FetchEngine.InstanceParams,
              >,
          >,
      >
    • Optionaloptions: ListenerOptions

    Returns Cleanup

    Example

    const obs = new ObserverEngine();
    
    obs.on(/some/, ({ event, data }) => {
        console.log(event, data);
    });
    Copy