Skip to content

Commit

Permalink
fix: makes payload optional as documented
Browse files Browse the repository at this point in the history
  • Loading branch information
JaKXz committed May 7, 2018
1 parent 327d03c commit 62deb4a
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions src/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export interface FluxStandardAction<Payload, Meta = undefined> {
* By convention, if `error` is `true`, the `payload` SHOULD be an error object.
* This is akin to rejecting a promise with an error object.
*/
payload: Payload;
payload?: Payload;
/**
* The optional `error` property MAY be set to true if the action represents an error.
* An action whose `error` is true is analogous to a rejected Promise.
Expand All @@ -26,7 +26,10 @@ export interface FluxStandardAction<Payload, Meta = undefined> {
meta?: Meta;
}

export interface ErrorFluxStandardAction<CustomError extends Error, Meta = undefined> extends FluxStandardAction<CustomError, Meta> {
export interface ErrorFluxStandardAction<
CustomError extends Error,
Meta = undefined
> extends FluxStandardAction<CustomError, Meta> {
error: true;
}

Expand All @@ -38,14 +41,21 @@ export type FSA<Payload, Meta = undefined> = FluxStandardAction<Payload, Meta>;
/**
* Alias for ErrorFluxStandardAction.
*/
export type ErrorFSA<CustomError extends Error, Meta = undefined> = ErrorFluxStandardAction<CustomError, Meta>;
export type ErrorFSA<
CustomError extends Error,
Meta = undefined
> = ErrorFluxStandardAction<CustomError, Meta>;

/**
* Returns `true` if `action` is FSA compliant.
*/
export function isFSA<Payload, Meta = undefined>(action: any): action is FluxStandardAction<Payload, Meta>;
export function isFSA<Payload, Meta = undefined>(
action: any
): action is FluxStandardAction<Payload, Meta>;

/**
* Returns `true` if `action` is FSA compliant error.
*/
export function isError<CustomError extends Error, Meta = undefined>(action: any): action is ErrorFluxStandardAction<CustomError, Meta>;
export function isError<CustomError extends Error, Meta = undefined>(
action: any
): action is ErrorFluxStandardAction<CustomError, Meta>;

0 comments on commit 62deb4a

Please sign in to comment.