- Notifications
You must be signed in to change notification settings - Fork142
Add typings to the repo#33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -3,12 +3,13 @@ | ||
| "version": "0.6.1", | ||
| "description": "A human-friendly standard for Flux action objects", | ||
| "main": "lib/index.js", | ||
| "typings": "lib/index.d.ts", | ||
| "files": [ | ||
| "lib" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Doesn't the ["lib","index.d.ts"] There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. We can do that. Putting the file directly next to the source allows editor (VS Code) to pick it up automatically. | ||
| ], | ||
| "scripts": { | ||
| "prebuild": "npm run clean", | ||
| "build": "babel src --out-dir lib --copy-files", | ||
| "clean": "rimraf lib/", | ||
| "lint": "eslint src/ test/", | ||
| "prepublish": "npm test && npm run build", | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| export interface FluxStandardAction { | ||
| /** | ||
| * The `type` of an action identifies to the consumer the nature of the action that has occurred. | ||
| * Two actions with the same `type` MUST be strictly equivalent (using `===`) | ||
| */ | ||
| type: string | symbol; | ||
| /** | ||
| * The optional `payload` property MAY be any type of value. | ||
| * It represents the payload of the action. | ||
| * Any information about the action that is not the type or status of the action should be part of the `payload` field. | ||
| * 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?: any; | ||
| /** | ||
| * 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. | ||
| * By convention, the `payload` SHOULD be an error object. | ||
| * If `error` has any other value besides `true`, including `undefined`, the action MUST NOT be interpreted as an error. | ||
| */ | ||
| error?: boolean; | ||
| /** | ||
| * The optional `meta` property MAY be any type of value. | ||
| * It is intended for any extra information that is not part of the payload. | ||
| */ | ||
| meta?: any | ||
| } | ||
| /** | ||
| * Alias to FluxStandardAction for shorthand | ||
| */ | ||
| export type FSA = FluxStandardAction; | ||
| /** | ||
| * Returns `true` if `action` is FSA compliant. | ||
| */ | ||
| export function isFSA(action: any): boolean; | ||
| /** | ||
| * Returns `true` if `action` is FSA compliant error. | ||
| */ | ||
| export function isError(action: any): boolean; |