-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
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
fix: add missing typings and docs of createNamespacedHelpers #910
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 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
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 |
---|---|---|
@@ -1,32 +1,52 @@ | ||
import Vue = require("vue"); | ||
|
||
type Dictionary<T> = { [key: string]: T }; | ||
type Computed = () => any; | ||
type MutationMethod = (...args: any[]) => void; | ||
type ActionMethod = (...args: any[]) => Promise<any>; | ||
|
||
export function mapState (map: string[]): Dictionary<() => any>; | ||
export function mapState (namespace: string, map: string[]): Dictionary<() => any>; | ||
export function mapState (map: Dictionary<string>): Dictionary<() => any>; | ||
export function mapState (namespace: string, map: Dictionary<string>): Dictionary<() => any>; | ||
export function mapState <S>( | ||
map: Dictionary<(this: typeof Vue, state: S, getters: any) => any> | ||
): Dictionary<() => any>; | ||
export function mapState <S>( | ||
namespace: string, | ||
map: Dictionary<(this: typeof Vue, state: S, getters: any) => any> | ||
): Dictionary<() => any>; | ||
type Mapper<R> = { | ||
(map: string[]): Dictionary<R>; | ||
(map: Dictionary<string>): Dictionary<R>; | ||
}; | ||
|
||
type MutationMethod = (...args: any[]) => void; | ||
export function mapMutations (map: string[]): Dictionary<MutationMethod>; | ||
export function mapMutations (namespace: string, map: string[]): Dictionary<MutationMethod>; | ||
export function mapMutations (map: Dictionary<string>): Dictionary<MutationMethod>; | ||
export function mapMutations (namespace: string, map: Dictionary<string>): Dictionary<MutationMethod>; | ||
|
||
export function mapGetters (map: string[]): Dictionary<() => any>; | ||
export function mapGetters (namespace: string, map: string[]): Dictionary<() => any>; | ||
export function mapGetters (map: Dictionary<string>): Dictionary<() => any>; | ||
export function mapGetters (namespace: string, map: Dictionary<string>): Dictionary<() => any>; | ||
|
||
type ActionMethod = (...args: any[]) => Promise<any[]>; | ||
export function mapActions (map: string[]): Dictionary<ActionMethod>; | ||
export function mapActions (namespace: string, map: string[]): Dictionary<ActionMethod>; | ||
export function mapActions (map: Dictionary<string>): Dictionary<ActionMethod>; | ||
export function mapActions (namespace: string, map: Dictionary<string>): Dictionary<ActionMethod>; | ||
type MapperWithNamespace<R> = { | ||
(namespace: string, map: string[]): Dictionary<R>; | ||
(namespace: string, map: Dictionary<string>): Dictionary<R>; | ||
}; | ||
|
||
type MapperForState = { | ||
<S>( | ||
map: Dictionary<(this: typeof Vue, state: S, getters: any) => any> | ||
): Dictionary<Computed>; | ||
}; | ||
|
||
type MapperForStateWithNamespace = { | ||
<S>( | ||
namespace: string, | ||
map: Dictionary<(this: typeof Vue, state: S, getters: any) => any> | ||
): Dictionary<Computed>; | ||
}; | ||
|
||
interface NamespacedMappers { | ||
mapState: Mapper<Computed> & MapperForState; | ||
mapMutations: Mapper<MutationMethod>; | ||
mapGetters: Mapper<Computed>; | ||
mapActions: Mapper<ActionMethod>; | ||
} | ||
|
||
export declare const mapState: Mapper<Computed> | ||
& MapperWithNamespace<Computed> | ||
& MapperForState | ||
& MapperForStateWithNamespace; | ||
|
||
export declare const mapMutations: Mapper<MutationMethod> | ||
& MapperWithNamespace<MutationMethod>; | ||
|
||
export declare const mapGetters: Mapper<Computed> | ||
& MapperWithNamespace<Computed>; | ||
|
||
export declare const mapActions: Mapper<ActionMethod> | ||
& MapperWithNamespace<ActionMethod>; | ||
|
||
export declare function createNamespacedHelpers(namespace: string): NamespacedMappers; |
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
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.
I would prefer using interface as long as possible.
It enables module augmentations, and also is more performant when compiling.
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.
Thanks! I didn't know about the performance advantage of
interface
.