-
Notifications
You must be signed in to change notification settings - Fork 142
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
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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 publishedfiles
? I would rather you move this to the root so that this array can just be:There was a problem hiding this comment.
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.