Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add typings to the repo #33

Merged
merged 6 commits into from
Nov 18, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't the index.d.ts need to be in the published files? I would rather you move this to the root so that this array can just be:

[
  "lib",
  "index.d.ts"
]

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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",
"build": "babel src --out-dir lib --copy-files",
"clean": "rimraf lib/",
"lint": "eslint src/ test/",
"prepublish": "npm test && npm run build",
Expand Down
42 changes: 42 additions & 0 deletions src/index.d.ts
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;