Logo for jsDocs.io

redux-observable

  • Version 3.0.0-rc.2
  • Published
  • 69.1 kB
  • No dependencies
  • MIT license

Install

npm i redux-observable
yarn add redux-observable
pnpm add redux-observable

Overview

RxJS based middleware for Redux. Compose and cancel async actions and more.

Index

Functions

Classes

Interfaces

Functions

function combineEpics

combineEpics: <
    Input = unknown,
    Output extends Input = Input,
    State = void,
    Dependencies = any
>(
    ...epics: Epic<Input, Output, State, Dependencies>[]
) => Epic<Input, Output, State, Dependencies>;

  • Merges all epics into a single one.

function createEpicMiddleware

createEpicMiddleware: <
    Input = unknown,
    Output extends Input = Input,
    State = void,
    Dependencies = any
>(
    options?: Options<Dependencies>
) => EpicMiddleware<Input, Output, State, Dependencies>;

    function ofType

    ofType: <
        Input,
        Type extends string,
        Output extends Input = Extract<Input, Action<Type>>
    >(
        types_0: Type,
        ...types_1: Type[]
    ) => OperatorFunction<Input, Output>;

    • Inferring the types of this is a bit challenging, and only works in newer versions of TypeScript.

      Parameter

      ...types One or more Redux action types you want to filter for, variadic.

    Classes

    class StateObservable

    class StateObservable<S> extends Observable<S> {}

      constructor

      constructor(input$: Observable<S>, initialState: {});

        property value

        value: {};

          Interfaces

          interface Epic

          interface Epic<
              Input = unknown,
              Output extends Input = Input,
              State = void,
              Dependencies = any
          > {}

            call signature

            (
                action$: Observable<Input>,
                state$: StateObservable<State>,
                dependencies: Dependencies
            ): Observable<Output>;

              interface EpicMiddleware

              interface EpicMiddleware<
                  Input = unknown,
                  Output extends Input = Input,
                  State = void,
                  Dependencies = any
              > extends Middleware<{}, State> {}

                method run

                run: (rootEpic: Epic<Input, Output, State, Dependencies>) => void;

                  Package Files (1)

                  Dependencies (0)

                  No dependencies.

                  Dev Dependencies (16)

                  Peer Dependencies (2)

                  Badge

                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/redux-observable.

                  • Markdown
                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/redux-observable)
                  • HTML
                    <a href="https://www.jsdocs.io/package/redux-observable"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>