Skip to content

Commit

Permalink
core docs look ok
Browse files Browse the repository at this point in the history
  • Loading branch information
richytong committed Sep 29, 2020
1 parent 5074d9a commit b185e2d
Show file tree
Hide file tree
Showing 25 changed files with 409 additions and 3,255 deletions.
11 changes: 7 additions & 4 deletions all.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,15 @@ const symbolAsyncIterator = require('./_internal/symbolAsyncIterator')
*
* @synopsis
* ```coffeescript [specscript]
* Reducer<T> = (any, T)=>Promise|any
* Foldable<T> = Iterable<T>|AsyncIterable<T>
* |{ reduce: (any, T)=>any }|Object<T>
* |{ reduce: Reducer<T>=>any }|Object<T>
*
* all<T>(
* var T any,
* predicate T=>Promise|boolean,
* )(value Foldable<T>) -> allTruthyByPredicate Promise|boolean
* foldable Foldable<T>
*
* all(predicate)(foldable) -> Promise|boolean
* ```
*
* @description
Expand All @@ -34,7 +37,7 @@ const symbolAsyncIterator = require('./_internal/symbolAsyncIterator')
* ) // true
* ```
*
* The predicate may return a Promise, while the value may be an asynchronous stream.
* The value may be an asynchronous stream.
*
* ```javascript [playground]
* const asyncNumbers = async function* () {
Expand Down
7 changes: 4 additions & 3 deletions and.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,14 @@ const _asyncAndInterlude = (
*
* @synopsis
* ```coffeescript [specscript]
* and(
* var value any,
* predicates Array<value=>Promise|boolean>
* )(value any) -> allTruthy Promise|boolean
*
* and(predicates)(value) -> Promise|boolean
* ```
*
* @description
* Test an array of predicates concurrently against a single input, returning true if all are truthy. Predicates may be asynchronous.
* Test an array of predicates concurrently against a single input, returning true if all test truthy.
*
* ```javascript [playground]
* const isOdd = number => number % 2 == 1
Expand Down
10 changes: 6 additions & 4 deletions any.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,15 @@ const symbolAsyncIterator = require('./_internal/symbolAsyncIterator')
* Foldable<T> = Iterable<T>|AsyncIterable<T>
* |{ reduce: Reducer<T>=>any }|Object<T>
*
* any<T>(
* var T any,
* predicate T=>Promise|boolean,
* )(value Foldable<T>) -> anyTruthyByPredicate Promise|boolean
* foldable Foldable<T>
*
* any(predicate)(foldable) -> Promise|boolean
* ```
*
* @description
* Test a predicate concurrently across all items of a collection, returning true if any predication is truthy.
* Test a predicate concurrently across all items of a collection, returning true if any test truthy.
*
* ```javascript [playground]
* const isOdd = number => number % 2 == 1
Expand All @@ -32,7 +34,7 @@ const symbolAsyncIterator = require('./_internal/symbolAsyncIterator')
* ) // true
* ```
*
* The predicate may return a Promise, while the value may be an asynchronous stream.
* The value may be an asynchronous stream.
*
* ```javascript [playground]
* const toTodosUrl = id => 'https://jsonplaceholder.typicode.com/todos/' + id
Expand Down
10 changes: 5 additions & 5 deletions assign.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ const funcObjectAll = require('./_internal/funcObjectAll')
*
* @synopsis
* ```coffeescript [specscript]
* assign<
* source Object,
* funcsObject Object<source=>Promise|any>,
* >(funcsObject)(source) -> resultsMergedWithSource Promise|Object
* var source Object,
* funcsObject Object<source=>Promise|any>
*
* assign(funcsObject)(source) -> resultsMergedWithSource Promise|Object
* ```
*
* @description
* Compose an object from a source object merged with the evaluations of the property functions of a specifying object of functions. Functions of the specifying object of functions may be asynchronous.
* Compose an object from a source object merged with the evaluations of a specifying object of functions. Functions of the specifying object may return Promises.
*
* ```javascript [playground]
* console.log(
Expand Down
13 changes: 8 additions & 5 deletions eq.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,17 @@ const __ = require('./_internal/placeholder')
*
* @synopsis
* ```coffeescript [specscript]
* eq(
* left (any=>Promise|boolean)|any,
* right (any=>Promise|boolean)|any,
* ) -> strictEqualBy (value any)=>Promise|boolean
* var value any,
* leftCompare any,
* rightCompare any,
* left (value=>Promise|leftCompare)|leftCompare,
* right (value=>Promise|rightCompare)|rightCompare
*
* eq(left, right)(value) -> Promise|boolean
* ```
*
* @description
* Test for strict equality (`===`) between two values. Either parameter may be an asynchronous resolver.
* Test for strict equality (`===`) between the returns of two functions. Either parameter may be an actual value.
*
* ```javascript [playground]
* const personIsGeorge = eq(person => person.name, 'George')
Expand Down
Loading

0 comments on commit b185e2d

Please sign in to comment.