Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit59855bf

Browse files
committed
Add more API docs
1 parent904a91f commit59855bf

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

‎README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,28 @@ Creates Action Creator factory with optional prefix for action types.
184184
*`prefix?:string`: Prefix to be prepended to action types.
185185
*`defaultIsError?:Predicate`: Function that detects whether action is error
186186
given the payload. Default is`payload=>payloadinstanceofError`.
187+
188+
###`ActionCreatorFactory<P>(type:string,commonMeta?:object,isError?:boolean):ActionCreator<P>`
189+
190+
Creates Action Creator that produces actions with given`type` and payload of type`P`.
191+
192+
*`type:string`: Type of created actions.
193+
*`commonMeta?:object`: Metadata added to created actions.
194+
*`isError?:boolean`: Defines whether created actions are error actions.
195+
196+
###`ActionCreatorFactory#async<P,S,E>(type:string,commonMeta?:object):AsyncActionCreators<P,S,E>`
197+
198+
Creates three Action Creators:`started`,`done` and`failed`, useful to wrap asynchronous processes.
199+
200+
*`type:string`: Prefix for types of created actions, which will have types`${type}_STARTED`,`${type}_DONE` and`${type}_FAILED`.
201+
*`commonMeta?:object`: Metadata added to created actions.
202+
203+
###`ActionCreator(payload:P,meta?:object):Action<P>`
204+
205+
Creates action with given payload and metadata.
206+
207+
*`payload:P`: Action payload.
208+
*`meta?:object`: Action metadata. Merged with`commonMeta` of Action Creator.
187209
188210
###`isType(action:Action,actionCreator:ActionCreator):boolean`
189211

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp