ramda-json-docs

Ramda documentation in JSON format. Automatically updated by @rai-bot.

Generated with ramda-json-docs-generator.

Used for alfred-ramda-workflow.

Latest: https://raine.github.io/ramda-json-docs/latest.json

name	sig	category
F	* -> Boolean	Function
T	* -> Boolean	Function
__		Function
add	Number -> Number -> Number	Math
curryN	Number -> (* -> a) -> (* -> a)	Function
addIndex	((a ... -> b) ... -> [a] -> *) -> ((a ..., Int, [a] -> b) ... -> [a] -> *)	Function
adjust	Number -> (a -> a) -> [a] -> [a]	List
all	(a -> Boolean) -> [a] -> Boolean	List
max	Ord a => a -> a -> a	Relation
bind	(* -> *) -> {*} -> (* -> *)	Function
keys	{k: v} -> [k]	Object
map	Functor f => (a -> b) -> f a -> f b	List
path	[Idx] -> {a} -> a | Undefined	Object
prop	s -> {s: a} -> a | Undefined	Object
pluck	Functor f => k -> f {k: v} -> f v	List
reduce	((a, b) -> a) -> a -> [b] -> a	List
allPass	[(*... -> Boolean)] -> (*... -> Boolean)	Logic
always	a -> (* -> a)	Function
and	a -> b -> a | b	Logic
any	(a -> Boolean) -> [a] -> Boolean	List
anyPass	[(*... -> Boolean)] -> (*... -> Boolean)	Logic
ap	[a -> b] -> [a] -> [b]	Function
aperture	Number -> [a] -> [[a]]	List
append	a -> [a] -> [a]	List
apply	(*... -> a) -> [*] -> a	Function
values	{k: v} -> [v]	Object
applySpec	{k: ((a, b, ..., m) -> v)} -> ((a, b, ..., m) -> {k: v})	Function
applyTo	a -> (a -> b) -> b	Function
ascend	Ord b => (a -> b) -> a -> a -> Number	Function
assoc	String -> a -> {k: v} -> {k: v}	Object
isNil	* -> Boolean	Type
assocPath	[Idx] -> a -> {a} -> {a}	Object
nAry	Number -> (* -> a) -> (* -> a)	Function
binary	(* -> c) -> (a, b -> c)	Function
liftN	Number -> (*... -> *) -> ([*]... -> [*])	Function
lift	(*... -> *) -> ([*]... -> [*])	Function
both	(*... -> Boolean) -> (*... -> Boolean) -> (*... -> Boolean)	Logic
curry	(* -> a) -> (* -> a)	Function
call	(*... -> a),*... -> a	Function
chain	Chain m => (a -> m b) -> m a -> m b	List
clamp	Ord a => a -> a -> a -> a	Relation
type	(* -> {*}) -> String	Type
clone	{*} -> {*}	Object
comparator	((a, b) -> Boolean) -> ((a, b) -> Number)	Function
not	* -> Boolean	Logic
complement	(*... -> *) -> (*... -> Boolean)	Logic
slice	Number -> Number -> [a] -> [a]	List
tail	[a] -> [a]	List
pipe	(((a, b, ..., n) -> o), (o -> p), ..., (x -> y), (y -> z)) -> ((a, b, ..., n) -> z)	Function
reverse	[a] -> [a]	List
compose	((y -> z), (x -> y), ..., (o -> p), ((a, b, ..., n) -> o)) -> ((a, b, ..., n) -> z)	Function
composeK	Chain m => ((y -> m z), (x -> m y), ..., (a -> m b)) -> (a -> m z)	Function
pipeP	((a -> Promise b), (b -> Promise c), ..., (y -> Promise z)) -> (a -> Promise z)	Function
composeP	((y -> Promise z), (x -> Promise y), ..., (a -> Promise b)) -> (a -> Promise z)	Function
nth	Number -> [a] -> a | Undefined	List
head	[a] -> a | Undefined	List
identity	a -> a	Function
pipeWith	((* -> *), [((a, b, ..., n) -> o), (o -> p), ..., (x -> y), (y -> z)]) -> ((a, b, ..., n) -> z)	Function
composeWith	((* -> *), [(y -> z), (x -> y), ..., (o -> p), ((a, b, ..., n) -> o)]) -> ((a, b, ..., n) -> z)	Function
equals	a -> b -> Boolean	Relation
filter	Filterable f => (a -> Boolean) -> f a -> f a	List
reject	Filterable f => (a -> Boolean) -> f a -> f a	List
toString$1	* -> String	String
concat	[a] -> [a] -> [a]	List
cond	[[(*... -> Boolean),(*... -> *)]] -> (*... -> *)	Logic
constructN	Number -> (* -> {*}) -> (* -> {*})	Function
construct	(* -> {*}) -> (* -> {*})	Function
contains$1	a -> [a] -> Boolean	List
converge	((x1, x2, ...) -> z) -> [((a, b, ...) -> x1), ((a, b, ...) -> x2), ...] -> (a -> b -> ... -> z)	Function
reduceBy	((a, b) -> a) -> a -> (b -> String) -> [b] -> {String: a}	List
countBy	(a -> String) -> [a] -> {*}	Relation
dec	Number -> Number	Math
defaultTo	a -> b -> a | b	Logic
descend	Ord b => (a -> b) -> a -> a -> Number	Function
difference	[*] -> [*] -> [*]	Relation
differenceWith	((a, a) -> Boolean) -> [a] -> [a] -> [a]	Relation
dissoc	String -> {k: v} -> {k: v}	Object
remove	Number -> Number -> [a] -> [a]	List
update	Number -> a -> [a] -> [a]	List
dissocPath	[Idx] -> {k: v} -> {k: v}	Object
divide	Number -> Number -> Number	Math
drop	Number -> [a] -> [a]	List
take	Number -> [a] -> [a]	List
dropLast	Number -> [a] -> [a]	List
dropLastWhile	(a -> Boolean) -> [a] -> [a]	List
last	[a] -> a | Undefined	List
dropRepeatsWith	((a, a) -> Boolean) -> [a] -> [a]	List
dropRepeats	[a] -> [a]	List
dropWhile	(a -> Boolean) -> [a] -> [a]	List
or	a -> b -> a | b	Logic
either	(*... -> Boolean) -> (*... -> Boolean) -> (*... -> Boolean)	Logic
empty	a -> a	Function
takeLast	Number -> [a] -> [a]	List
endsWith	[a] -> [a] -> Boolean	List
eqBy	(a -> b) -> a -> a -> Boolean	Relation
eqProps	k -> {k: v} -> {k: v} -> Boolean	Object
evolve	{k: (v -> v)} -> {k: v} -> {k: v}	Object
find	(a -> Boolean) -> [a] -> a | undefined	List
findIndex	(a -> Boolean) -> [a] -> Number	List
findLast	(a -> Boolean) -> [a] -> a | undefined	List
findLastIndex	(a -> Boolean) -> [a] -> Number	List
flatten	[a] -> [b]	List
flip	((a, b, c, ...) -> z) -> (b -> a -> c -> ... -> z)	Function
forEach	(a -> *) -> [a] -> [a]	List
forEachObjIndexed	((a, String, StrMap a) -> Any) -> StrMap a -> StrMap a	Object
fromPairs	[[k,v]] -> {k: v}	List
groupBy	(a -> String) -> [a] -> {String: [a]}	List
groupWith	((a, a) → Boolean) → [a] → [[a]]	List
gt	Ord a => a -> a -> Boolean	Relation
gte	Ord a => a -> a -> Boolean	Relation
hasPath	[Idx] -> {a} -> Boolean	Object
has	s -> {s: x} -> Boolean	Object
hasIn	s -> {s: x} -> Boolean	Object
identical	a -> a -> Boolean	Relation
ifElse	(*... -> Boolean) -> (*... -> *) -> (*... -> *) -> (*... -> *)	Logic
inc	Number -> Number	Math
includes	a -> [a] -> Boolean	List
indexBy	(a -> String) -> [{k: v}] -> {k: {k: v}}	List
indexOf	a -> [a] -> Number	List
init	[a] -> [a]	List
innerJoin	((a, b) -> Boolean) -> [a] -> [b] -> [a]	Relation
insert	Number -> a -> [a] -> [a]	List
insertAll	Number -> [a] -> [a] -> [a]	List
uniqBy	(a -> b) -> [a] -> [a]	List
uniq	[a] -> [a]	List
intersection	[*] -> [*] -> [*]	Relation
intersperse	a -> [a] -> [a]	List
objOf	String -> a -> {String:a}	Object
into	a -> (b -> b) -> [c] -> a	List
invert	{s: x} -> {x: [ s, ... ]}	Object
invertObj	{s: x} -> {x: s}	Object
invoker	Number -> String -> (a -> b -> ... -> n -> Object -> *)	Function
is	(* -> {*}) -> a -> Boolean	Type
isEmpty	a -> Boolean	Logic
join	String -> [a] -> String	List
juxt	[(a, b, ..., m) -> n] -> ((a, b, ..., m) -> [n])	Function
keysIn	{k: v} -> [k]	Object
lastIndexOf	a -> [a] -> Number	List
length	[a] -> Number	List
lens	(s -> a) -> ((a, s) -> s) -> Lens s a	Object
lensIndex	Number -> Lens s a	Object
lensPath	[Idx] -> Lens s a	Object
lensProp	String -> Lens s a	Object
lt	Ord a => a -> a -> Boolean	Relation
lte	Ord a => a -> a -> Boolean	Relation
mapAccum	((acc, x) -> (acc, y)) -> acc -> [x] -> (acc, [y])	List
mapAccumRight	((acc, x) -> (acc, y)) -> acc -> [x] -> (acc, [y])	List
mapObjIndexed	((*, String, Object) -> *) -> Object -> Object	Object
match	RegExp -> String -> [String | Undefined]	String
mathMod	Number -> Number -> Number	Math
maxBy	Ord b => (a -> b) -> a -> a -> a	Relation
sum	[Number] -> Number	Math
mean	[Number] -> Number	Math
median	[Number] -> Number	Math
memoizeWith	(*... -> String) -> (*... -> a) -> (*... -> a)	Function
merge	{k: v} -> {k: v} -> {k: v}	Object
mergeAll	[{k: v}] -> {k: v}	List
mergeWithKey	((String, a, a) -> a) -> {a} -> {a} -> {a}	Object
mergeDeepWithKey	((String, a, a) -> a) -> {a} -> {a} -> {a}	Object
mergeDeepLeft	{a} -> {a} -> {a}	Object
mergeDeepRight	{a} -> {a} -> {a}	Object
mergeDeepWith	((a, a) -> a) -> {a} -> {a} -> {a}	Object
mergeLeft	{k: v} -> {k: v} -> {k: v}	Object
mergeRight	{k: v} -> {k: v} -> {k: v}	Object
mergeWith	((a, a) -> a) -> {a} -> {a} -> {a}	Object
min	Ord a => a -> a -> a	Relation
minBy	Ord b => (a -> b) -> a -> a -> a	Relation
modulo	Number -> Number -> Number	Math
multiply	Number -> Number -> Number	Math
negate	Number -> Number	Math
none	(a -> Boolean) -> [a] -> Boolean	List
nthArg	Number -> *... -> *	Function
o	(b -> c) -> (a -> b) -> a -> c	Function
of	a -> [a]	Function
omit	[String] -> {String: *} -> {String: *}	Object
once	(a... -> b) -> (a... -> b)	Function
otherwise	(e -> b) -> (Promise e a) -> (Promise e b)	Function
over	Lens s a -> (a -> a) -> s -> s	Object
pair	a -> b -> (a,b)	List
partial	((a, b, c, ..., n) -> x) -> [a, b, c, ...] -> ((d, e, f, ..., n) -> x)	Function
partialRight	((a, b, c, ..., n) -> x) -> [d, e, f, ..., n] -> ((a, b, c, ...) -> x)	Function
partition	Filterable f => (a -> Boolean) -> f a -> [f a, f a]	List
pathEq	[Idx] -> a -> {a} -> Boolean	Relation
pathOr	a -> [Idx] -> {a} -> a	Object
pathSatisfies	(a -> Boolean) -> [Idx] -> {a} -> Boolean	Logic
pick	[k] -> {k: v} -> {k: v}	Object
pickAll	[k] -> {k: v} -> {k: v}	Object
pickBy	((v, k) -> Boolean) -> {k: v} -> {k: v}	Object
pipeK	Chain m => ((a -> m b), (b -> m c), ..., (y -> m z)) -> (a -> m z)	Function
prepend	a -> [a] -> [a]	List
product	[Number] -> Number	Math
useWith	((x1, x2, ...) -> z) -> [(a -> x1), (b -> x2), ...] -> (a -> b -> ... -> z)	Function
project	[k] -> [{k: v}] -> [{k: v}]	Object
propEq	String -> a -> Object -> Boolean	Relation
propIs	Type -> String -> Object -> Boolean	Type
propOr	a -> String -> Object -> a	Object
propSatisfies	(a -> Boolean) -> String -> {String: a} -> Boolean	Logic
props	[k] -> {k: v} -> [v]	Object
range	Number -> Number -> [Number]	List
reduceRight	((a, b) -> b) -> b -> [a] -> b	List
reduceWhile	((a, b) -> Boolean) -> ((a, b) -> a) -> a -> [b] -> a	List
reduced	a -> *	List
times	(Number -> a) -> Number -> [a]	List
repeat	a -> n -> [a]	List
replace	RegExp|String -> String -> String -> String	String
scan	((a, b) -> a) -> a -> [b] -> [a]	List
sequence	(Applicative f, Traversable t) => (a -> f a) -> t (f a) -> f (t a)	List
set	Lens s a -> a -> s -> s	Object
sort	((a, a) -> Number) -> [a] -> [a]	List
sortBy	Ord b => (a -> b) -> [a] -> [a]	Relation
sortWith	[(a, a) -> Number] -> [a] -> [a]	Relation
split	(String | RegExp) -> String -> [String]	String
splitAt	Number -> [a] -> [[a], [a]]	List
splitEvery	Number -> [a] -> [[a]]	List
splitWhen	(a -> Boolean) -> [a] -> [[a], [a]]	List
startsWith	[a] -> [a] -> Boolean	List
subtract	Number -> Number -> Number	Math
symmetricDifference	[*] -> [*] -> [*]	Relation
symmetricDifferenceWith	((a, a) -> Boolean) -> [a] -> [a] -> [a]	Relation
takeLastWhile	(a -> Boolean) -> [a] -> [a]	List
takeWhile	(a -> Boolean) -> [a] -> [a]	List
tap	(a -> *) -> a -> a	Function
test	RegExp -> String -> Boolean	String
then	(a -> b) -> (Promise e a) -> (Promise e b)	Function
toLower	String -> String	String
toPairs	{String: *} -> [[String,*]]	Object
toPairsIn	{String: *} -> [[String,*]]	Object
toUpper	String -> String	String
transduce	(c -> c) -> ((a, b) -> a) -> a -> [b] -> a	List
transpose	[[a]] -> [[a]]	List
traverse	(Applicative f, Traversable t) => (a -> f a) -> (a -> f b) -> t a -> f (t b)	List
trim	String -> String	String
tryCatch	(...x -> a) -> ((e, ...x) -> a) -> (...x -> a)	Function
unapply	([*...] -> a) -> (*... -> a)	Function
unary	(* -> b) -> (a -> b)	Function
uncurryN	Number -> (a -> b) -> (a -> c)	Function
unfold	(a -> [b]) -> * -> [b]	List
union	[*] -> [*] -> [*]	Relation
uniqWith	((a, a) -> Boolean) -> [a] -> [a]	List
unionWith	((a, a) -> Boolean) -> [*] -> [*] -> [*]	Relation
unless	(a -> Boolean) -> (a -> a) -> a -> a	Logic
unnest	Chain c => c (c a) -> c a	List
until	(a -> Boolean) -> (a -> a) -> a -> a	Logic
valuesIn	{k: v} -> [v]	Object
view	Lens s a -> s -> a	Object
when	(a -> Boolean) -> (a -> a) -> a -> a	Logic
where	{String: (* -> Boolean)} -> {String: *} -> Boolean	Object
whereEq	{String: *} -> {String: *} -> Boolean	Object
without	[a] -> [a] -> [a]	List
xprod	[a] -> [b] -> [[a,b]]	List
zip	[a] -> [b] -> [[a,b]]	List
zipObj	[String] -> [*] -> {String: *}	List
zipWith	((a, b) -> c) -> [a] -> [b] -> [c]	List
thunkify	((a, b, ..., j) -> k) -> (a, b, ..., j) -> (() -> k)	Function