@appnest/typed-actions
Advanced tools
Comparing version 1.0.5 to 1.0.6
/** | ||
* Type for the "id" field of actions. | ||
*/ | ||
export declare type ActionIdType = string; | ||
declare type ActionIdType = string; | ||
/** | ||
* Default type for action payload if not specified. | ||
*/ | ||
export declare type DefaultActionPayloadType = void; | ||
declare type DefaultActionPayloadType = void; | ||
/** | ||
* Default type for action metadata if not specified. | ||
*/ | ||
export declare type DefaultActionMetaType = void; | ||
declare type DefaultActionMetaType = void; | ||
/** | ||
* All actions come with a "status" field. | ||
*/ | ||
export declare enum ActionStatusKind { | ||
declare enum ActionStatusKind { | ||
START = "START", | ||
@@ -24,3 +24,3 @@ SUCCESS = "SUCCESS", | ||
*/ | ||
export declare const DEFAULT_ACTION_STATUS_KIND = ActionStatusKind.SUCCESS; | ||
declare const DEFAULT_ACTION_STATUS_KIND = ActionStatusKind.SUCCESS; | ||
/** | ||
@@ -31,3 +31,3 @@ * The action type used for all action. | ||
*/ | ||
export declare type Action<Payload = unknown, Meta = unknown> = { | ||
declare type Action<Payload = unknown, Meta = unknown> = { | ||
type: string; | ||
@@ -43,3 +43,3 @@ id: ActionIdType; | ||
*/ | ||
export interface StartAction<Start, Meta> extends Action<Start, Meta> { | ||
interface StartAction<Start, Meta> extends Action<Start, Meta> { | ||
status: ActionStatusKind.START; | ||
@@ -53,3 +53,3 @@ error: false; | ||
*/ | ||
export interface SuccessAction<Success, Meta> extends Action<Success, Meta> { | ||
interface SuccessAction<Success, Meta> extends Action<Success, Meta> { | ||
status: ActionStatusKind.SUCCESS; | ||
@@ -63,3 +63,3 @@ error: false; | ||
*/ | ||
export interface FailureAction<Failure, Meta> extends Action<Failure, Meta> { | ||
interface FailureAction<Failure, Meta> extends Action<Failure, Meta> { | ||
status: ActionStatusKind.FAILURE; | ||
@@ -73,3 +73,3 @@ error: true; | ||
*/ | ||
export declare type AsyncAction<Start = DefaultActionPayloadType, Success = DefaultActionPayloadType, Failure = DefaultActionPayloadType, Meta = DefaultActionMetaType> = StartAction<Start, Meta> | SuccessAction<Success, Meta> | FailureAction<Failure, Meta>; | ||
declare type AsyncAction<Start = DefaultActionPayloadType, Success = DefaultActionPayloadType, Failure = DefaultActionPayloadType, Meta = DefaultActionMetaType> = StartAction<Start, Meta> | SuccessAction<Success, Meta> | FailureAction<Failure, Meta>; | ||
/** | ||
@@ -82,3 +82,3 @@ * Optional spread two generic parameters. | ||
*/ | ||
export declare type OptionalSpreadTuple<T, U> = IfVoid<U, IfVoid<T, [T?, U?], [T, U?]>, [T, U]>; | ||
declare type OptionalSpreadTuple<T, U> = IfVoid<U, IfVoid<T, [T?, U?], [T, U?]>, [T, U]>; | ||
/** | ||
@@ -91,3 +91,3 @@ * Optional spread two generic parameters always forcing the last one to be optional. | ||
*/ | ||
export declare type OptionalSpreadTupleAlwaysOptional<T, U> = IfVoid<T, [T?, U?], [T, U?]>; | ||
declare type OptionalSpreadTupleAlwaysOptional<T, U> = IfVoid<T, [T?, U?], [T, U?]>; | ||
/** | ||
@@ -98,3 +98,3 @@ * Choose the first type if T is "void". | ||
*/ | ||
export declare type IfVoid<T, VoidType, ElseType> = T extends undefined ? ElseType : (T extends null ? ElseType : (T extends void ? VoidType : ElseType)); | ||
declare type IfVoid<T, VoidType, ElseType> = T extends undefined ? ElseType : (T extends null ? ElseType : (T extends void ? VoidType : ElseType)); | ||
/** | ||
@@ -107,3 +107,3 @@ * Creates an action object. | ||
*/ | ||
export declare function mkAction<Payload = DefaultActionPayloadType, Meta = DefaultActionMetaType>(id: ActionIdType, status: ActionStatusKind, ...payloadAndMeta: OptionalSpreadTuple<Payload, Meta>): Action<Payload, Meta>; | ||
declare function mkAction<Payload = DefaultActionPayloadType, Meta = DefaultActionMetaType>(id: ActionIdType, status: ActionStatusKind, ...payloadAndMeta: OptionalSpreadTuple<Payload, Meta>): Action<Payload, Meta>; | ||
declare type P = DefaultActionPayloadType; | ||
@@ -115,3 +115,3 @@ declare type M = DefaultActionMetaType; | ||
*/ | ||
export interface ActionCreatorBase<Payload, Meta> { | ||
interface ActionCreatorBase<Payload, Meta> { | ||
id: ActionIdType; | ||
@@ -123,3 +123,3 @@ status: ActionStatusKind; | ||
*/ | ||
export interface ActionCreator<Payload = P, Meta = M> extends ActionCreatorBase<Payload, Meta> { | ||
interface ActionCreator<Payload = P, Meta = M> extends ActionCreatorBase<Payload, Meta> { | ||
(...args: OptionalSpreadTuple<Payload, Meta>): Action<Payload, Meta>; | ||
@@ -131,3 +131,3 @@ } | ||
*/ | ||
export interface ActionCreatorWithMeta<Payload = P, Meta = M> extends ActionCreatorBase<Payload, Meta> { | ||
interface ActionCreatorWithMeta<Payload = P, Meta = M> extends ActionCreatorBase<Payload, Meta> { | ||
meta: Meta; | ||
@@ -143,4 +143,4 @@ (...args: OptionalSpreadTupleAlwaysOptional<Payload, Meta>): Action<Payload, Meta>; | ||
*/ | ||
export declare function actionCreator<Payload = P, Meta = M>(id: ActionIdType, status?: ActionStatusKind): IfVoid<Meta, ActionCreatorWithMeta<Payload, Meta>, ActionCreator<Payload, Meta>>; | ||
export declare function actionCreator<Payload = P, Meta = M>(id: ActionIdType, status: ActionStatusKind, defaultMeta: Meta): ActionCreatorWithMeta<Payload, Meta>; | ||
declare function actionCreator<Payload = P, Meta = M>(id: ActionIdType, status?: ActionStatusKind): IfVoid<Meta, ActionCreatorWithMeta<Payload, Meta>, ActionCreator<Payload, Meta>>; | ||
declare function actionCreator<Payload = P, Meta = M>(id: ActionIdType, status: ActionStatusKind, defaultMeta: Meta): ActionCreatorWithMeta<Payload, Meta>; | ||
/** | ||
@@ -152,3 +152,5 @@ * Checks if an action was made from a specific action creator using a type guard. | ||
*/ | ||
export declare function isAction<Payload, Meta>(action: Action<unknown, unknown>, actionCreator: ActionCreator<Payload, Meta> | ActionCreatorWithMeta<Payload, Meta>): action is Action<Payload, Meta>; | ||
declare function isAction<Payload, Meta>(action: Action<unknown, unknown>, actionCreator: ActionCreator<Payload, Meta> | ActionCreatorWithMeta<Payload, Meta>): action is Action<Payload, Meta>; | ||
declare type P_$0 = DefaultActionPayloadType; | ||
declare type M_$0 = DefaultActionMetaType; | ||
/** | ||
@@ -158,3 +160,3 @@ * The base of async actions creators. | ||
*/ | ||
export interface AsyncActionCreatorBase<Start, Success, Failure, Meta> { | ||
interface AsyncActionCreatorBase<Start, Success, Failure, Meta> { | ||
id: ActionIdType; | ||
@@ -166,3 +168,3 @@ } | ||
*/ | ||
export interface AsyncActionCreator<Start = P, Success = P, Failure = P, Meta = M> extends AsyncActionCreatorBase<Start, Success, Failure, Meta> { | ||
interface AsyncActionCreator<Start = P_$0, Success = P_$0, Failure = P_$0, Meta = M_$0> extends AsyncActionCreatorBase<Start, Success, Failure, Meta> { | ||
start: ActionCreator<Start, Meta>; | ||
@@ -176,3 +178,3 @@ success: ActionCreator<Success, Meta>; | ||
*/ | ||
export interface AsyncActionCreatorWithMeta<Start = P, Success = P, Failure = P, Meta = M> extends AsyncActionCreatorBase<Start, Success, Failure, Meta> { | ||
interface AsyncActionCreatorWithMeta<Start = P_$0, Success = P_$0, Failure = P_$0, Meta = M_$0> extends AsyncActionCreatorBase<Start, Success, Failure, Meta> { | ||
meta: Meta; | ||
@@ -188,4 +190,4 @@ start: ActionCreatorWithMeta<Start, Meta>; | ||
*/ | ||
export declare function asyncActionCreator<Start = P, Success = P, Failure = P, Meta = M>(id: ActionIdType): IfVoid<Meta, AsyncActionCreatorWithMeta<Start, Success, Failure, Meta>, AsyncActionCreator<Start, Success, Failure, Meta>>; | ||
export declare function asyncActionCreator<Start = P, Success = P, Failure = P, Meta = M>(id: ActionIdType, defaultMeta: Meta): AsyncActionCreatorWithMeta<Start, Success, Failure, Meta>; | ||
declare function asyncActionCreator<Start = P_$0, Success = P_$0, Failure = P_$0, Meta = M_$0>(id: ActionIdType): IfVoid<Meta, AsyncActionCreatorWithMeta<Start, Success, Failure, Meta>, AsyncActionCreator<Start, Success, Failure, Meta>>; | ||
declare function asyncActionCreator<Start = P_$0, Success = P_$0, Failure = P_$0, Meta = M_$0>(id: ActionIdType, defaultMeta: Meta): AsyncActionCreatorWithMeta<Start, Success, Failure, Meta>; | ||
/** | ||
@@ -197,3 +199,3 @@ * Checks if the "action" has been made from a specific "actionCreator". | ||
*/ | ||
export declare function isAsyncAction<Start, Success, Failure, Meta>(action: Action<unknown, unknown>, actionCreator: AsyncActionCreator<Start, Success, Failure, Meta> | AsyncActionCreatorWithMeta<Start, Success, Failure, Meta>): action is AsyncAction<Start, Success, Failure, Meta>; | ||
declare function isAsyncAction<Start, Success, Failure, Meta>(action: Action<unknown, unknown>, actionCreator: AsyncActionCreator<Start, Success, Failure, Meta> | AsyncActionCreatorWithMeta<Start, Success, Failure, Meta>): action is AsyncAction<Start, Success, Failure, Meta>; | ||
/** | ||
@@ -205,3 +207,3 @@ * Default action creator with built in metadata where only the Success and Meta types are user defined. | ||
*/ | ||
export declare type DefaultAsyncActionCreatorWithMeta<Success = DefaultActionPayloadType, Meta = DefaultActionMetaType> = AsyncActionCreatorWithMeta<void, Success, Error, Meta>; | ||
declare type DefaultAsyncActionCreatorWithMeta<Success = DefaultActionPayloadType, Meta = DefaultActionMetaType> = AsyncActionCreatorWithMeta<void, Success, Error, Meta>; | ||
/** | ||
@@ -213,3 +215,3 @@ * Default action creator where only the Success and Meta types are user defined. | ||
*/ | ||
export declare type DefaultAsyncActionCreator<Success = DefaultActionPayloadType, Meta = DefaultActionMetaType> = AsyncActionCreator<void, Success, Error, Meta>; | ||
declare type DefaultAsyncActionCreator<Success = DefaultActionPayloadType, Meta = DefaultActionMetaType> = AsyncActionCreator<void, Success, Error, Meta>; | ||
/** | ||
@@ -222,3 +224,3 @@ * Creates a default async action creator where only the Success and Meta types are user defined. | ||
*/ | ||
export declare function defaultAsyncActionCreator<Success = DefaultActionPayloadType, Meta = DefaultActionMetaType>(idOrNamespace?: ActionIdType, id?: ActionIdType): IfVoid<Meta, DefaultAsyncActionCreatorWithMeta<Success, Meta>, DefaultAsyncActionCreator<Success, Meta>>; | ||
declare function defaultAsyncActionCreator<Success = DefaultActionPayloadType, Meta = DefaultActionMetaType>(idOrNamespace?: ActionIdType, id?: ActionIdType): IfVoid<Meta, DefaultAsyncActionCreatorWithMeta<Success, Meta>, DefaultAsyncActionCreator<Success, Meta>>; | ||
/** | ||
@@ -231,4 +233,4 @@ * Returns a curried function with a action dispatcher function. | ||
*/ | ||
export declare const tryCatchDispatch: (dispatch: (action: Action<unknown, unknown>) => void) => <Success, Meta>(actionCreator: AsyncActionCreatorWithMeta, handler: () => Success | Promise<Success>) => Promise<Success>; | ||
declare const tryCatchDispatch: (dispatch: (action: Action<unknown, unknown>) => void) => <Success, Meta>(actionCreator: AsyncActionCreatorWithMeta<void, Success, Error, Meta>, handler: () => Success | Promise<Success>) => Promise<Success>; | ||
export { ActionIdType, DefaultActionPayloadType, DefaultActionMetaType, ActionStatusKind, DEFAULT_ACTION_STATUS_KIND, Action, ActionCreatorBase, ActionCreator, ActionCreatorWithMeta, actionCreator, isAction, mkAction, StartAction, SuccessAction, FailureAction, AsyncAction, AsyncActionCreatorBase, AsyncActionCreator, AsyncActionCreatorWithMeta, asyncActionCreator, isAsyncAction, DefaultAsyncActionCreatorWithMeta, DefaultAsyncActionCreator, defaultAsyncActionCreator, tryCatchDispatch, OptionalSpreadTuple, OptionalSpreadTupleAlwaysOptional, IfVoid }; | ||
//# sourceMappingURL=index.cjs.d.ts.map |
@@ -18,15 +18,6 @@ 'use strict'; | ||
/* | ||
* Helpers used for treating "undefined" generic parameters as optional. | ||
* See Typescript issue https://github.com/Microsoft/TypeScript/issues/12400 for more information. | ||
* Until this issue has been closed it's possible to simulate optional generic parameters using tuple types and spread expressions. | ||
* | ||
* Example: | ||
* createAction<Payload, Meta>(...payloadAndMeta: OptionalSpreadTuple<Payload, Meta>) | ||
* | ||
* createAction<undefined, undefined>(); | ||
* createAction<string, undefined>("hello"); | ||
* createAction<string, string>("hello", "world"); | ||
*/ | ||
/** | ||
@@ -33,0 +24,0 @@ * Creates an action object. |
/** | ||
* Type for the "id" field of actions. | ||
*/ | ||
export declare type ActionIdType = string; | ||
declare type ActionIdType = string; | ||
/** | ||
* Default type for action payload if not specified. | ||
*/ | ||
export declare type DefaultActionPayloadType = void; | ||
declare type DefaultActionPayloadType = void; | ||
/** | ||
* Default type for action metadata if not specified. | ||
*/ | ||
export declare type DefaultActionMetaType = void; | ||
declare type DefaultActionMetaType = void; | ||
/** | ||
* All actions come with a "status" field. | ||
*/ | ||
export declare enum ActionStatusKind { | ||
declare enum ActionStatusKind { | ||
START = "START", | ||
@@ -24,3 +24,3 @@ SUCCESS = "SUCCESS", | ||
*/ | ||
export declare const DEFAULT_ACTION_STATUS_KIND = ActionStatusKind.SUCCESS; | ||
declare const DEFAULT_ACTION_STATUS_KIND = ActionStatusKind.SUCCESS; | ||
/** | ||
@@ -31,3 +31,3 @@ * The action type used for all action. | ||
*/ | ||
export declare type Action<Payload = unknown, Meta = unknown> = { | ||
declare type Action<Payload = unknown, Meta = unknown> = { | ||
type: string; | ||
@@ -43,3 +43,3 @@ id: ActionIdType; | ||
*/ | ||
export interface StartAction<Start, Meta> extends Action<Start, Meta> { | ||
interface StartAction<Start, Meta> extends Action<Start, Meta> { | ||
status: ActionStatusKind.START; | ||
@@ -53,3 +53,3 @@ error: false; | ||
*/ | ||
export interface SuccessAction<Success, Meta> extends Action<Success, Meta> { | ||
interface SuccessAction<Success, Meta> extends Action<Success, Meta> { | ||
status: ActionStatusKind.SUCCESS; | ||
@@ -63,3 +63,3 @@ error: false; | ||
*/ | ||
export interface FailureAction<Failure, Meta> extends Action<Failure, Meta> { | ||
interface FailureAction<Failure, Meta> extends Action<Failure, Meta> { | ||
status: ActionStatusKind.FAILURE; | ||
@@ -73,3 +73,3 @@ error: true; | ||
*/ | ||
export declare type AsyncAction<Start = DefaultActionPayloadType, Success = DefaultActionPayloadType, Failure = DefaultActionPayloadType, Meta = DefaultActionMetaType> = StartAction<Start, Meta> | SuccessAction<Success, Meta> | FailureAction<Failure, Meta>; | ||
declare type AsyncAction<Start = DefaultActionPayloadType, Success = DefaultActionPayloadType, Failure = DefaultActionPayloadType, Meta = DefaultActionMetaType> = StartAction<Start, Meta> | SuccessAction<Success, Meta> | FailureAction<Failure, Meta>; | ||
/** | ||
@@ -82,3 +82,3 @@ * Optional spread two generic parameters. | ||
*/ | ||
export declare type OptionalSpreadTuple<T, U> = IfVoid<U, IfVoid<T, [T?, U?], [T, U?]>, [T, U]>; | ||
declare type OptionalSpreadTuple<T, U> = IfVoid<U, IfVoid<T, [T?, U?], [T, U?]>, [T, U]>; | ||
/** | ||
@@ -91,3 +91,3 @@ * Optional spread two generic parameters always forcing the last one to be optional. | ||
*/ | ||
export declare type OptionalSpreadTupleAlwaysOptional<T, U> = IfVoid<T, [T?, U?], [T, U?]>; | ||
declare type OptionalSpreadTupleAlwaysOptional<T, U> = IfVoid<T, [T?, U?], [T, U?]>; | ||
/** | ||
@@ -98,3 +98,3 @@ * Choose the first type if T is "void". | ||
*/ | ||
export declare type IfVoid<T, VoidType, ElseType> = T extends undefined ? ElseType : (T extends null ? ElseType : (T extends void ? VoidType : ElseType)); | ||
declare type IfVoid<T, VoidType, ElseType> = T extends undefined ? ElseType : (T extends null ? ElseType : (T extends void ? VoidType : ElseType)); | ||
/** | ||
@@ -107,3 +107,3 @@ * Creates an action object. | ||
*/ | ||
export declare function mkAction<Payload = DefaultActionPayloadType, Meta = DefaultActionMetaType>(id: ActionIdType, status: ActionStatusKind, ...payloadAndMeta: OptionalSpreadTuple<Payload, Meta>): Action<Payload, Meta>; | ||
declare function mkAction<Payload = DefaultActionPayloadType, Meta = DefaultActionMetaType>(id: ActionIdType, status: ActionStatusKind, ...payloadAndMeta: OptionalSpreadTuple<Payload, Meta>): Action<Payload, Meta>; | ||
declare type P = DefaultActionPayloadType; | ||
@@ -115,3 +115,3 @@ declare type M = DefaultActionMetaType; | ||
*/ | ||
export interface ActionCreatorBase<Payload, Meta> { | ||
interface ActionCreatorBase<Payload, Meta> { | ||
id: ActionIdType; | ||
@@ -123,3 +123,3 @@ status: ActionStatusKind; | ||
*/ | ||
export interface ActionCreator<Payload = P, Meta = M> extends ActionCreatorBase<Payload, Meta> { | ||
interface ActionCreator<Payload = P, Meta = M> extends ActionCreatorBase<Payload, Meta> { | ||
(...args: OptionalSpreadTuple<Payload, Meta>): Action<Payload, Meta>; | ||
@@ -131,3 +131,3 @@ } | ||
*/ | ||
export interface ActionCreatorWithMeta<Payload = P, Meta = M> extends ActionCreatorBase<Payload, Meta> { | ||
interface ActionCreatorWithMeta<Payload = P, Meta = M> extends ActionCreatorBase<Payload, Meta> { | ||
meta: Meta; | ||
@@ -143,4 +143,4 @@ (...args: OptionalSpreadTupleAlwaysOptional<Payload, Meta>): Action<Payload, Meta>; | ||
*/ | ||
export declare function actionCreator<Payload = P, Meta = M>(id: ActionIdType, status?: ActionStatusKind): IfVoid<Meta, ActionCreatorWithMeta<Payload, Meta>, ActionCreator<Payload, Meta>>; | ||
export declare function actionCreator<Payload = P, Meta = M>(id: ActionIdType, status: ActionStatusKind, defaultMeta: Meta): ActionCreatorWithMeta<Payload, Meta>; | ||
declare function actionCreator<Payload = P, Meta = M>(id: ActionIdType, status?: ActionStatusKind): IfVoid<Meta, ActionCreatorWithMeta<Payload, Meta>, ActionCreator<Payload, Meta>>; | ||
declare function actionCreator<Payload = P, Meta = M>(id: ActionIdType, status: ActionStatusKind, defaultMeta: Meta): ActionCreatorWithMeta<Payload, Meta>; | ||
/** | ||
@@ -152,3 +152,5 @@ * Checks if an action was made from a specific action creator using a type guard. | ||
*/ | ||
export declare function isAction<Payload, Meta>(action: Action<unknown, unknown>, actionCreator: ActionCreator<Payload, Meta> | ActionCreatorWithMeta<Payload, Meta>): action is Action<Payload, Meta>; | ||
declare function isAction<Payload, Meta>(action: Action<unknown, unknown>, actionCreator: ActionCreator<Payload, Meta> | ActionCreatorWithMeta<Payload, Meta>): action is Action<Payload, Meta>; | ||
declare type P_$0 = DefaultActionPayloadType; | ||
declare type M_$0 = DefaultActionMetaType; | ||
/** | ||
@@ -158,3 +160,3 @@ * The base of async actions creators. | ||
*/ | ||
export interface AsyncActionCreatorBase<Start, Success, Failure, Meta> { | ||
interface AsyncActionCreatorBase<Start, Success, Failure, Meta> { | ||
id: ActionIdType; | ||
@@ -166,3 +168,3 @@ } | ||
*/ | ||
export interface AsyncActionCreator<Start = P, Success = P, Failure = P, Meta = M> extends AsyncActionCreatorBase<Start, Success, Failure, Meta> { | ||
interface AsyncActionCreator<Start = P_$0, Success = P_$0, Failure = P_$0, Meta = M_$0> extends AsyncActionCreatorBase<Start, Success, Failure, Meta> { | ||
start: ActionCreator<Start, Meta>; | ||
@@ -176,3 +178,3 @@ success: ActionCreator<Success, Meta>; | ||
*/ | ||
export interface AsyncActionCreatorWithMeta<Start = P, Success = P, Failure = P, Meta = M> extends AsyncActionCreatorBase<Start, Success, Failure, Meta> { | ||
interface AsyncActionCreatorWithMeta<Start = P_$0, Success = P_$0, Failure = P_$0, Meta = M_$0> extends AsyncActionCreatorBase<Start, Success, Failure, Meta> { | ||
meta: Meta; | ||
@@ -188,4 +190,4 @@ start: ActionCreatorWithMeta<Start, Meta>; | ||
*/ | ||
export declare function asyncActionCreator<Start = P, Success = P, Failure = P, Meta = M>(id: ActionIdType): IfVoid<Meta, AsyncActionCreatorWithMeta<Start, Success, Failure, Meta>, AsyncActionCreator<Start, Success, Failure, Meta>>; | ||
export declare function asyncActionCreator<Start = P, Success = P, Failure = P, Meta = M>(id: ActionIdType, defaultMeta: Meta): AsyncActionCreatorWithMeta<Start, Success, Failure, Meta>; | ||
declare function asyncActionCreator<Start = P_$0, Success = P_$0, Failure = P_$0, Meta = M_$0>(id: ActionIdType): IfVoid<Meta, AsyncActionCreatorWithMeta<Start, Success, Failure, Meta>, AsyncActionCreator<Start, Success, Failure, Meta>>; | ||
declare function asyncActionCreator<Start = P_$0, Success = P_$0, Failure = P_$0, Meta = M_$0>(id: ActionIdType, defaultMeta: Meta): AsyncActionCreatorWithMeta<Start, Success, Failure, Meta>; | ||
/** | ||
@@ -197,3 +199,3 @@ * Checks if the "action" has been made from a specific "actionCreator". | ||
*/ | ||
export declare function isAsyncAction<Start, Success, Failure, Meta>(action: Action<unknown, unknown>, actionCreator: AsyncActionCreator<Start, Success, Failure, Meta> | AsyncActionCreatorWithMeta<Start, Success, Failure, Meta>): action is AsyncAction<Start, Success, Failure, Meta>; | ||
declare function isAsyncAction<Start, Success, Failure, Meta>(action: Action<unknown, unknown>, actionCreator: AsyncActionCreator<Start, Success, Failure, Meta> | AsyncActionCreatorWithMeta<Start, Success, Failure, Meta>): action is AsyncAction<Start, Success, Failure, Meta>; | ||
/** | ||
@@ -205,3 +207,3 @@ * Default action creator with built in metadata where only the Success and Meta types are user defined. | ||
*/ | ||
export declare type DefaultAsyncActionCreatorWithMeta<Success = DefaultActionPayloadType, Meta = DefaultActionMetaType> = AsyncActionCreatorWithMeta<void, Success, Error, Meta>; | ||
declare type DefaultAsyncActionCreatorWithMeta<Success = DefaultActionPayloadType, Meta = DefaultActionMetaType> = AsyncActionCreatorWithMeta<void, Success, Error, Meta>; | ||
/** | ||
@@ -213,3 +215,3 @@ * Default action creator where only the Success and Meta types are user defined. | ||
*/ | ||
export declare type DefaultAsyncActionCreator<Success = DefaultActionPayloadType, Meta = DefaultActionMetaType> = AsyncActionCreator<void, Success, Error, Meta>; | ||
declare type DefaultAsyncActionCreator<Success = DefaultActionPayloadType, Meta = DefaultActionMetaType> = AsyncActionCreator<void, Success, Error, Meta>; | ||
/** | ||
@@ -222,3 +224,3 @@ * Creates a default async action creator where only the Success and Meta types are user defined. | ||
*/ | ||
export declare function defaultAsyncActionCreator<Success = DefaultActionPayloadType, Meta = DefaultActionMetaType>(idOrNamespace?: ActionIdType, id?: ActionIdType): IfVoid<Meta, DefaultAsyncActionCreatorWithMeta<Success, Meta>, DefaultAsyncActionCreator<Success, Meta>>; | ||
declare function defaultAsyncActionCreator<Success = DefaultActionPayloadType, Meta = DefaultActionMetaType>(idOrNamespace?: ActionIdType, id?: ActionIdType): IfVoid<Meta, DefaultAsyncActionCreatorWithMeta<Success, Meta>, DefaultAsyncActionCreator<Success, Meta>>; | ||
/** | ||
@@ -231,4 +233,4 @@ * Returns a curried function with a action dispatcher function. | ||
*/ | ||
export declare const tryCatchDispatch: (dispatch: (action: Action<unknown, unknown>) => void) => <Success, Meta>(actionCreator: AsyncActionCreatorWithMeta, handler: () => Success | Promise<Success>) => Promise<Success>; | ||
declare const tryCatchDispatch: (dispatch: (action: Action<unknown, unknown>) => void) => <Success, Meta>(actionCreator: AsyncActionCreatorWithMeta<void, Success, Error, Meta>, handler: () => Success | Promise<Success>) => Promise<Success>; | ||
export { ActionIdType, DefaultActionPayloadType, DefaultActionMetaType, ActionStatusKind, DEFAULT_ACTION_STATUS_KIND, Action, ActionCreatorBase, ActionCreator, ActionCreatorWithMeta, actionCreator, isAction, mkAction, StartAction, SuccessAction, FailureAction, AsyncAction, AsyncActionCreatorBase, AsyncActionCreator, AsyncActionCreatorWithMeta, asyncActionCreator, isAsyncAction, DefaultAsyncActionCreatorWithMeta, DefaultAsyncActionCreator, defaultAsyncActionCreator, tryCatchDispatch, OptionalSpreadTuple, OptionalSpreadTupleAlwaysOptional, IfVoid }; | ||
//# sourceMappingURL=index.esm.d.ts.map |
@@ -15,15 +15,6 @@ /** | ||
/* | ||
* Helpers used for treating "undefined" generic parameters as optional. | ||
* See Typescript issue https://github.com/Microsoft/TypeScript/issues/12400 for more information. | ||
* Until this issue has been closed it's possible to simulate optional generic parameters using tuple types and spread expressions. | ||
* | ||
* Example: | ||
* createAction<Payload, Meta>(...payloadAndMeta: OptionalSpreadTuple<Payload, Meta>) | ||
* | ||
* createAction<undefined, undefined>(); | ||
* createAction<string, undefined>("hello"); | ||
* createAction<string, string>("hello", "world"); | ||
*/ | ||
/** | ||
@@ -30,0 +21,0 @@ * Creates an action object. |
{ | ||
"name": "@appnest/typed-actions", | ||
"version": "1.0.5", | ||
"version": "1.0.6", | ||
"description": "A lightweight library to create and type check flux/redux actions in typescript", | ||
@@ -29,3 +29,3 @@ "author": "runem", | ||
"devDependencies": { | ||
"@wessberg/rollup-plugin-ts": "^1.1.22", | ||
"@wessberg/rollup-plugin-ts": "^1.1.31", | ||
"rollup": "^1.1.2", | ||
@@ -32,0 +32,0 @@ "typescript": "^3.3.1" |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
49575
682