typescript-fsa

property error

error?: boolean;

property meta

meta?: Meta;

property payload

payload: Payload;

property type

type: string;

property match

match: (action: AnyAction) => action is Action<Payload>;

• Identical to isType except it is exposed as a bound method of an action creator. Since it is bound and takes a single argument it is ideal for passing to a filtering function like Array.prototype.filter or RxJS's Observable.prototype.filter.

  Example 1

  const somethingHappened = actionCreator<{foo: string}>('SOMETHING_HAPPENED'); const somethingElseHappened = actionCreator<{bar: number}>('SOMETHING_ELSE_HAPPENED');

  if (somethingHappened.match(action)) { // action.payload has type {foo: string} }

  const actionArray = [ somethingHappened({foo: 'foo'}), somethingElseHappened({bar: 5}), ];

  // somethingHappenedArray has inferred type Action<{foo: string}>[] const somethingHappenedArray = actionArray.filter(somethingHappened.match);

property type

type: string;

call signature

(payload: Payload, meta?: Meta): Action<Payload>;

• Creates action with given payload and metadata.

  Parameter payload

  Action payload.

  Parameter meta

  Action metadata. Merged with commonMeta of Action Creator.

method async

async: <Params, Result, Error = {}>(
    type: string,
    commonMeta?: Meta
) => AsyncActionCreators<Params, Result, Error>;

• Creates three Action Creators: * started: ActionCreator<Params> * done: ActionCreator<{params: Params, result: Result}> * failed: ActionCreator<{params: Params, error: Error}>

  Useful to wrap asynchronous processes.

  Parameter type

  Prefix for types of created actions, which will have types ${type}_STARTED, ${type}_DONE and ${type}_FAILED.

  Parameter commonMeta

  Metadata added to created actions.

call signature

<Payload = void>(
    type: string,
    commonMeta?: Meta,
    isError?: boolean
): ActionCreator<Payload>;

• Creates Action Creator that produces actions with given type and payload of type Payload.

  Parameter type

  Type of created actions.

  Parameter commonMeta

  Metadata added to created actions.

  Parameter isError

  Defines whether created actions are error actions.

call signature

<Payload = void>(
    type: string,
    commonMeta?: Meta,
    isError?: (payload: Payload) => boolean
): ActionCreator<Payload>;

• Creates Action Creator that produces actions with given type and payload of type Payload.

  Parameter type

  Type of created actions.

  Parameter commonMeta

  Metadata added to created actions.

  Parameter isError

  Function that detects whether action is error given the payload.

property type

type: any;

property done

done: ActionCreator<Success<Params, Result>>;

property failed

failed: ActionCreator<Failure<Params, Error>>;

property started

started: ActionCreator<Params>;

property type

type: string;