Interface EffectRunner<Request, Response, TError, TState>

An EffectRunner is a function, enhanced with Observable properties

interface EffectRunner<Request, Response, TError, TState> {
    cancelCurrent: (() => void);
    cancelCurrentAndQueued: (() => void);
    cancelations: Observable<Request>;
    completions: Observable<Request>;
    currentError: BehaviorSubject<null | TError>;
    errors: Observable<TError>;
    isActive: BehaviorSubject<boolean>;
    isHandling: BehaviorSubject<boolean>;
    lastResponse: BehaviorSubject<null | Response>;
    reduceWith: ((reducer, initial) => BehaviorSubject<TState>);
    request: ((req) => void);
    responses: Observable<Response>;
    send: ((req, matcher?) => Promise<Response>);
    shutdown: (() => void);
    starts: Observable<Request>;
    state: BehaviorSubject<null | TState>;
    unsubscribe: (() => void);
    observe(callbacks): Subscription;
    (req): void;
}

Type Parameters

  • Request
  • Response
  • TError extends Error = Error
  • TState = Response

Hierarchy

Properties

cancelCurrent cancelCurrentAndQueued cancelations completions currentError errors isActive isHandling lastResponse reduceWith request responses send shutdown starts state unsubscribe

Methods

observe

Properties

cancelCurrent

cancelCurrent: (() => void)

Cancels the current effect.

Type declaration

    • (): void

    • Returns void

cancelCurrentAndQueued

cancelCurrentAndQueued: (() => void)

Cancels the current effect, and unqueues any queued effects.

Type declaration

    • (): void

    • Returns void

cancelations

cancelations: Observable<Request>

completions

completions: Observable<Request>

currentError

currentError: BehaviorSubject<null | TError>

errors

errors: Observable<TError>

isActive

isActive: BehaviorSubject<boolean>

isHandling

isHandling: BehaviorSubject<boolean>

lastResponse

lastResponse: BehaviorSubject<null | Response>

reduceWith

reduceWith: ((reducer, initial) => BehaviorSubject<TState>)

Populates #state via the reducer. Meant to be called only once, before

Type declaration

request

request: ((req) => void)

Type declaration

    • (req): void

    • Parameters

      Returns void

responses

responses: Observable<Response>

send

send: ((req, matcher?) => Promise<Response>)

Returns a Promise for the next result. CAUTION: In concurrent situations this is usually not what you want!

Type declaration

    • (req, matcher?): Promise<Response>

    • Parameters

      • req: Request
      • Optional matcher: ((req, res) => boolean)

      Returns Promise<Response>

shutdown

shutdown: (() => void)

Invokes cancelCurrentAndQueued, and stops listening for new requests.

Type declaration

    • (): void

    • Returns void

starts

starts: Observable<Request>

state

state: BehaviorSubject<null | TState>

unsubscribe

unsubscribe: (() => void)

Alias for cancelCurrentAndQueued.

Type declaration

    • (): void

    • Returns void

Methods

observe

Settings

Member Visibility

Theme

On This Page

cancelCurrentcancelCurrentAndQueuedcancelationscompletionscurrentErrorerrorsisActiveisHandlinglastResponsereduceWithrequestresponsessendshutdownstartsstateunsubscribeobserve