Skip to content

Commit e4ce067

Browse files
chore: fix some parameters types and hide private details from public api docs.
1 parent 1ae4b26 commit e4ce067

3 files changed

Lines changed: 17 additions & 5 deletions

File tree

api.jq

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,17 @@ map(select(.longname == "module.exports") | {
8686
params: params,
8787
returns: returns,
8888
examples: examples
89-
})
89+
} |
90+
91+
#####################################################################
92+
### POST PROCESSING RULES ###
93+
#####################################################################
94+
95+
# into can be given a symbol as its first argument
96+
# but that is private implementation details that must be hidden
97+
# from the public api
98+
99+
if (.function_name == "into" | not) then . else
100+
.params |= map(.type -= ["symbol"])
101+
end
102+
)

src/_operator.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66
const __ = require('./__');
77

88
/**
9-
* @param {?} a
10-
* @param {?} b
9+
* @param {function(?, ?): ?} fn
1110
* @return {?}
1211
*/
1312
module.exports = fn => function (a, b) {

src/into.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ Transformer(Assoc, function(acc, value, key) {
5555
* //=> '1121'
5656
*
5757
* @curried
58-
* @param {Array|Object|string} init
59-
* @param {function()} transducer
58+
* @param {Array|Object|string|symbol} init
59+
* @param {function(?): ?} transducer
6060
* @param {Array|Object} xs
6161
* @return {Array|Object|string}
6262
*/

0 commit comments

Comments
 (0)