Merge pull request #26 from Sykander/develop

Release 1.0.1

Author: Sykander

README.md

@@ -1,82 +1,63 @@
-# Iterable Async Methods
+# Iterable Async Methods 
+[![Try iterable-async on RunKit](https://badge.runkitcdn.com/iterable-async.svg)](https://npm.runkit.com/iterable-async)
 
-## Async Map
+A collection of methods for looping iterable objects asynchronously using something similar to the Array api.
 
+## Installation
+
+```
+$ npm install iterable-async
 ```
-/**
+
+## Methods
+
+* Async Filter
+* Async Find
+* Async Find Index
+* Async For Each
 * Async Map
-* Map an array asynchronously and resolve when all callbacks are resolved
-* Will map independently from order when callbacks are async
-* @async
-* @param {Function} callback - callback(currentValue, index, array)
-* @param {Object} [thisArg] - must be iterable
-* @return {Array}
-* @throws {TypeError}
-*/
-function asyncMap(callback, [thisArg]) {...}
+
+### Async Filter 
+
+Filter an iterable object asynchronously
+```
+function asyncFilter(callback, [thisArg]) {...}
 ```
 
-## Async For Each
+### Async Find
 
+Find an item in an iterable object asynchronously
 ```
-/**
-* Async For Each
-* Loop over an array asynchronously and resolve when all callbacks are resolved
-* Will loop independently from order when callbacks are async
-* @async
-* @param {Function} callback - callback(currentValue, index, array)
-* @param {Object} [thisArg] - must be iterable
-* @throws {TypeError}
-*/
-function asyncForEach(callback, [thisArg]) {...}
+function asyncFind(callback, [thisArg]) {...}
 ```
 
-## Async Filter 
+### Async Find Index
 
+Find an item's index in an iterable object asynchronously
 ```
-/**
-* Async Filter
-* Filter an iterable object asynchronously and resolve when all callbacks are resolved
-* @async
-* @param {Function} callback - callback(currentValue, index, array)
-* @param {Object} [thisArg] - must be iterable
-* @return {Array}
-* @throws {TypeError}
-*/
-function asyncFilter(callback, [thisArg]) {...}
+async function asyncFindIndex(callback, [thisArg]) {...}
 ```
 
-## Async Find
+### [Async For Each](https://github.com/Sykander/iterable-async/wiki/Async-For-Each)
 
+Loop over an iterable object asynchronously
 ```
-/**
-* Async Find
-* Find an item in an iterable object asynchronously and resolve when found or all callbacks resolve
-* @async
-* @param {Function} callback - callback(currentValue, index, array)
-* @param {Object} [thisArg] - must be iterable
-* @return {any}
-* @throws {TypeError}
-*/
+function asyncForEach(callback, [thisArg]) {...}
 ```
 
-## Async Find Index
+### Async Map
 
+Map an iterable object asynchronously
 ```
-/**
-* Async Find Index
-* Find an item's index in an iterable object asynchronously and resolve when found or all callbacks resolve
-* @async
-* @param {Function} callback - callback(currentValue, index, array)
-* @param {Object} [thisArg] - must be iterable
-* @return {Number} - an integer index, -1 if not found
-* @throws {TypeError}
-*/
+function asyncMap(callback, [thisArg]) {...}
 ```
 
-# Development
 
-## Scripts
+## Development
+
+Development is open to contribution, check the project board "Development" for tickets.
+
+### Scripts
 
 ```
 npm run lint
@@ -92,6 +73,6 @@ npm test
 # Runs all tests
 ```
 
-## Commit Rules
+### Commit Rules
 
-* All commits should pass the lint check commandS
+* All commits should pass the lint check commands

docs/playground.js

@@ -0,0 +1,7 @@
+const {
+	asyncFind,
+	asyncFindIndex,
+	asyncFilter,
+	asyncForEach,
+	asyncMap
+} = require('iterable-async');

package.json

@@ -5,17 +5,18 @@
   "main": "src",
   "scripts": {
     "test": "./node_modules/.bin/mocha test",
-    "lint:fix": "./node_modules/.bin/eslint src test --fix && ./node_modules/.bin/prettier --write 'src/**/*.{js,ts,css,html}' --write 'test/**/*.{js,ts,css,html}'",
+    "lint:fix": "./node_modules/.bin/prettier --write 'src/**/*.{js,ts,css,html}' --write 'test/**/*.{js,ts,css,html}' --write 'docs/**/*.{js,ts,css,html}'",
     "lint:check": "./node_modules/.bin/eslint src test",
-    "lint": "npm run lint:fix && npm run lint:check"
+    "lint": "npm run lint:fix && npm run lint:check",
+    "prepublishOnly": "npm run lint:check && npm test"
   },
   "author": {
     "name": "Sykander Gul",
     "email": "scanda@live.co.uk"
   },
   "repository": {
-    "type" : "git",
-    "url" : "https://github.com/Sykander/patterns.git"
+    "type": "git",
+    "url": "https://github.com/Sykander/iterable-async.git"
   },
   "license": "MIT",
   "devDependencies": {
@@ -33,5 +34,6 @@
     "hooks": {
       "pre-commit": "npm run lint:check"
     }
-  }
+  },
+  "runkitExampleFilename": "docs/playground.js"
 }