Updated Documentation to include new Selector logic

Author: mrprim

README.md

@@ -8,7 +8,7 @@ When using Redux with Redux-Sagas, asynchronous options end up being fairly comp
 
 Other libraries exist for handling asynchronous actions, usually by including middlewares.  However, if you are already using the Redux-Saga middleware, it adds an extra layer of complication to add a new middleware on top of Redux-Sagas.
 
-**Async-Ops** uses the Redux-Saga middleware to handle asynchronous operations, unifying all types of async calls under a small number of actionTypes which are handled by a single saga.  Whenever you want to add a new asynchronous operation, all that you need to do is create an operation method using whatever technology you like (we like to use the Javascript `fetch` API for simplicity), register that operation, and fire the Async-Ops actions with the registered name and, boom.
+**Async-Ops** uses the Redux-Saga middleware to handle asynchronous operations, unifying all types of async calls under a small number of actionTypes which are handled by a single saga.  Whenever you want to add a new asynchronous operation, all that you need to do is create an operation function using whatever technology you like (we like to use the Javascript `fetch` API for simplicity), register that operation, and fire the Async-Ops actions with the registered name and, boom.
 
 ## Usage
 Async-Ops is available on npm with the following command:
@@ -18,7 +18,7 @@ Async-Ops is available on npm with the following command:
 
 ## API
 ### `register(name:String, operation:Function, mockOperation: Function) : Function`
-The `register` method registers an `operation` method and a `mockOperation` method under a given name.  Operations must be registered prior to being used by the application.
+The `register` function registers an `operation` function and a `mockOperation` function under a given name.  Operations must be registered prior to being used by the application.
 
 #### Arguments
 
@@ -40,7 +40,7 @@ register('fetchData', service, mock)
 ```
 
 ### `callOperation(name:String, ...args) : Function`
-The `callOperation` method retrieves the `operation` registered at the provided name and then calls it, passing in `..args` to the called method.
+The `callOperation` function retrieves the `operation` registered at the provided name and then calls it, passing in `..args` to the called function.
 
 #### Arguments
 
@@ -50,7 +50,7 @@ The `callOperation` method retrieves the `operation` registered at the provided
 
 
 #### Return : Promise(result)
-`callOperation` returns the result of the previously registered `operation` method (or its `mockOperation`) after invoking it with the provided `...args`.  If the `operation` result is not a `Promise`, it will be wrapped in a resolved `Promise`.
+`callOperation` returns the result of the previously registered `operation` function (or its `mockOperation`) after invoking it with the provided `...args`.  If the `operation` result is not a `Promise`, it will be wrapped in a resolved `Promise`.
 
 #### Example
 ```javascript
@@ -66,18 +66,18 @@ const x = await callOperation('fetchData', 1) // x = 2
 ```
 
 ### `enableMock() : Function`
-The `enableMock` method causes `callOperation` to use the `mockOperation` method rather than the  `operation` method.  The current mock status is set in the client's Local Storage.
+The `enableMock` function causes `callOperation` to use the `mockOperation` function rather than the  `operation` function.  The current mock status is set in the client's Local Storage.
 
 ### `disableMock() : Function`
-The `enableMock` method causes `callOperation` to use the `mockOperation` method rather than the  `operation` method.  The current mock status is set in the client's Local Storage.
+The `enableMock` function causes `callOperation` to use the `mockOperation` function rather than the  `operation` function.  The current mock status is set in the client's Local Storage.
 
 ### `actions : Object`
 
-The `actions` object contains action creator methods which create the actions which are used by the Async-Ops `saga` to automatically run and process Async-Ops operations.
+The `actions` object contains action creator functions which create the actions which are used by the Async-Ops `saga` to automatically run and process Async-Ops operations.
 
 ### `actions.asyncOperationStart : Function(name:String | options:Object, ...args)`
 
-The `asyncOperationStart` method creates an action which starts an async operation.
+The `asyncOperationStart` function creates an action which starts an async operation.
 
 #### Arguments
 
@@ -90,10 +90,10 @@ The `asyncOperationStart` method creates an action which starts an async operati
 **`...args`** The arguments to be passed to the `operation` when it is called.
 
 #### Return : Object
-The `asyncOperationStart` method returns a Redux-formatted action object with the following properties:
+The `asyncOperationStart` function returns a Redux-formatted action object with the following properties:
   * *`type : String`* This is always set to `'ASYNC_OPERATION'`
   * *`...args : Array[arg1, arg2, ...]`* an array of the args provided.
-  * *`...options`* any other option values provided to the method
+  * *`...options`* any other option values provided to the function
 
 #### Example
 ```javascript
@@ -126,7 +126,7 @@ sagaMiddleware.run(saga)
 
 ### `isAsyncOperation, isAsyncComplete, isAsyncFailure : Function(name:String, channel:String)`
 
-These three methods are helper methods.  They return a match function which takes an action Object and matches the actionType, name, and channel.  This can used for Redux-Saga matching and React-Redux reducer matching.
+These three functions are helper functions.  They return a match function which takes an action Object and matches the actionType, name, and channel.  This can used for Redux-Saga matching and React-Redux reducer matching.
 
 #### Arguments
 
@@ -135,4 +135,57 @@ These three methods are helper methods.  They return a match function which take
 **`channel : String [optional]`** A channel name to be matched.
 
 #### Return : Function(action : Object)
-The method returned from the helper methods takes an action object and returns either `true` if the action matches the provided info or `false` if the action does not.
+The function returned from the helper functions takes an action object and returns either `true` if the action matches the provided info or `false` if the action does not.
+
+### `reducer : Function`
+
+The `reducer` is a Redux reducer function that can added to an app's reducer to keep the store updated with the status about the latest async-ops calls.  It must be put under the key 'asyncops' which can be imported from the async-ops package as `STORE_DOMAIN`.
+
+### `loadingSelector : Function`
+
+This selector function can be used to determine the loading state of an asynchronous operation.
+
+#### Arguments
+
+**`name : String [required]`** The name of the operation.
+
+**`channel : String [optional]`** The name of the channel.
+
+#### Return : Function(action : Object)
+The function returned from the selector functions takes a state object and returns either `true` if the asynchronous operation is currently loading or `false` if it is not.
+
+#### Example
+```javascript
+import { loadingSelector } from 'async-ops'
+
+const mapStateToProps = state => ({
+  testOpIsLoading: loadingSelector('testOp')(state)
+})
+```
+
+export const loadingSelector = (name, channel) => state =>
+  statusSelector(name, channel).loading || false
+
+export const errorSelector = (name, channel) => state =>
+  statusSelector(name, channel).error || null
+### `errorSelector : Function`
+
+This selector function can be used to retrieve error data from an asynchronous operation.
+
+#### Arguments
+
+**`name : String [required]`** The name of the operation.
+
+**`channel : String [optional]`** The name of the channel.
+
+#### Return : Function(action : Object)
+The function returned from the selector functions takes a state object and returns either null if the asynchronous operation did not error or an error object.
+
+#### Example
+```javascript
+import { errorSelector } from 'async-ops'
+
+const mapStateToProps = state => ({
+  testOpError: errorSelector('testOp')(state)
+})
+```

src/index.js

@@ -4,7 +4,7 @@ import * as actionTypes from './actionTypes'
 import saga from './saga'
 import { call as callOperation, register } from './operations'
 import * as reducerHelpers from './helpers'
-import reducer from './reducer'
+import reducer, { STORE_DOMAIN } from './reducer'
 import * as selectors from './selectors'
 
 const isAsyncOperation = reducerHelpers.isAsyncOperation
@@ -24,7 +24,8 @@ export {
   isAsyncComplete,
   isAsyncFailure,
   reducer,
-  selectors
+  selectors,
+  STORE_DOMAIN
 }
 
 export default {
@@ -40,5 +41,6 @@ export default {
   isAsyncComplete,
   isAsyncFailure,
   reducer,
-  selectors
+  selectors,
+  STORE_DOMAIN
 }