Skip to content
pipelined
Docs
Search
Ctrl
K
Cancel
GitHub
npm
The basics
Installation
Thinking in pipelines
Designing with states
Composition utilities
Errors & absence
Maybe — Modeling Absence
Result — Modeling Failures
Validation — Accumulating Errors
These — Inclusive OR
Async
Task — Lazy Asynchronous Work
Deferred — Infallible Async Values
Op — Managing Async Operations
RemoteData — Loading States
Resource — Safe Lifecycle Management
State & context
Reader — Shared Contexts
State — Stateful Computations
Logged — Accumulated Logs
Nested data
Lens — Nested Updates
Optional — Nullable Paths
Tuple — Typed Pairs
Type safety
Brand — Distinguishing Values
Duration — Type-Safe Time
Non-Empty Collections — Compile-Time Guarantees
Refinement — Type Predicates
Predicate — Composable Logic
Comparing & combining
Equality — Composable Equality Checks
Ordering — Composable Comparators
Combinable — Combining Values
Lazy — Memoized Computations
Collection utilities
Arr — Array Utilities
Str — String Utilities
Num — Number Utilities
Rec — Record Utilities
Dict — Dictionary Utilities
Uniq — Unique Collections
Appendix
Why this exists
Design and influences
Performance and benchmarks
API Reference
Composition
Namespaces
tap
functions
async
inspect
log
time
type-aliases
AsyncOptions
InspectOptions
LogOptions
TimeConfig
Interfaces
flow
pipe
Functions
and
compose
constant
constFalse
constNull
constTrue
constUndefined
constVoid
converge
curry
curry3
curry4
defaultTo
flip
flow
identity
juxt
memoize
memoizeWeak
not
on
once
or
pipe
tap
uncurry
uncurry3
uncurry4
Core
Namespaces
Combinable
functions
array
fold
maybe
variables
all
any
product
string
sum
Deferred
namespaces
from
functions
Promise
to
functions
Promise
Equality
functions
and
array
by
variables
boolean
date
number
string
Lazy
functions
chain
evaluate
from
map
tap
Lens
functions
andThen
andThenOptional
get
modify
set
toOptional
namespaces
from
functions
accessors
property
Logged
functions
ap
bind
bindTo
chain
map
run
tap
namespaces
from
functions
entry
value
Maybe
functions
ap
bind
bindTo
chain
filter
fold
getOrElse
map
match
recover
struct
tap
namespaces
from
functions
nullable
Predicate
Result
is
functions
none
some
make
functions
none
some
to
functions
nullable
Result
undefined
Op
functions
all
chain
create
err
fold
getOrElse
interpret
isErr
isIdle
isNil
isOk
isPending
isQueued
isRetrying
lift
map
mapError
match
nil
ok
race
recover
tap
wire
namespaces
to
functions
Maybe
Result
type-aliases
AbortedNil
BufferedState
ConcurrentDropState
ConcurrentQueueState
DebouncedState
DroppedNil
Err
EvictedNil
ExclusiveState
Idle
KeyedExclusivePerKey
KeyedManager
KeyedRestartablePerKey
Manager
Nil
NilReason
Ok
OnceState
Outcome
Pending
Queued
QueueDropAndReplaceState
QueueDropState
QueueReplaceState
QueueState
ReplacedNil
RestartableState
RetryableBufferedState
RetryableConcurrentDropState
RetryableConcurrentQueueState
RetryableDebouncedState
RetryableExclusiveState
RetryableOnceState
RetryableQueueDropAndReplaceState
RetryableQueueDropState
RetryableQueueReplaceState
RetryableQueueState
RetryableRestartableState
RetryableThrottledState
RetryableThrottledTrailingState
Retrying
RetryOptions
State
ThrottledState
ThrottledTrailingState
TimeoutOptions
Optional
functions
index
andThen
andThenLens
fold
get
getOrElse
match
modify
set
namespaces
from
functions
accessors
property
Ordering
functions
by
reverse
thenBy
variables
date
number
string
Predicate
functions
all
and
any
not
or
using
namespaces
from
functions
Refinement
Reader
functions
ap
ask
asks
bind
bindTo
chain
local
map
resolve
run
tap
Refinement
functions
and
compose
or
namespaces
from
functions
predicate
to
functions
Maybe
Result
RemoteData
functions
ap
chain
filter
fold
getOrElse
map
mapError
match
recover
tap
tapError
namespaces
from
functions
Maybe
Result
is
functions
failure
loading
notAsked
success
make
functions
failure
loading
notAsked
success
to
functions
Maybe
Result
Resource
functions
combine
use
namespaces
from
functions
handlers
Task
Result
functions
ap
bind
bindTo
chain
fold
getOrElse
map
mapError
match
recover
recoverUnless
struct
tap
tapError
tryCatch
namespaces
from
functions
Maybe
nullable
Predicate
throwable
is
functions
err
ok
make
functions
err
ok
to
functions
Maybe
State
functions
ap
bind
bindTo
chain
evaluate
execute
get
gets
map
modify
put
resolve
run
tap
Task
functions
abortable
all
ap
bind
bindTo
chain
delay
map
race
repeat
repeatUntil
resolve
run
sequence
sequential
tap
timeout
namespaces
from
functions
Promise
sync
type-aliases
Maybe
Result
Validation
variables
Maybe
Result
Validation
TaskMaybe
functions
ap
bind
bindTo
chain
filter
fold
getOrElse
map
match
none
recover
some
struct
tap
tryCatch
namespaces
from
functions
Maybe
nullable
Result
Task
to
functions
Result
TaskResult
functions
ap
bind
bindTo
chain
err
fold
getOrElse
map
mapError
match
ok
recover
run
struct
tap
tapError
tryCatch
namespaces
from
functions
Maybe
nullable
Result
throwable
TaskValidation
functions
ap
failed
failedAll
fold
getOrElse
map
mapError
match
passed
product
productAll
recover
struct
tap
tapError
tryCatch
namespaces
from
functions
Maybe
nullable
Result
Validation
These
functions
chainFirst
chainSecond
fold
getFirstOrElse
getSecondOrElse
hasFirst
hasSecond
mapBoth
mapFirst
mapSecond
match
swap
tap
namespaces
is
functions
both
first
second
make
functions
both
first
second
Tuple
functions
first
fold
mapBoth
mapFirst
mapSecond
second
swap
tap
namespaces
from
functions
array
pair
to
functions
Array
Validation
functions
ap
fold
getOrElse
map
mapError
match
product
productAll
recover
recoverUnless
struct
tap
tapError
namespaces
from
functions
Maybe
nullable
Predicate
Result
is
functions
failed
passed
make
functions
failed
failedAll
passed
to
functions
Maybe
Result
Type Aliases
Combinable
Deferred
Equality
Err
Failed
Failure
Lazy
Lens
Loading
Logged
Maybe
None
NotAsked
Ok
Op
Optional
Ordering
Passed
Predicate
Reader
Refinement
RemoteData
Resource
Result
Some
State
Success
Task
TaskMaybe
TaskResult
TaskValidation
These
TheseBoth
TheseFirst
TheseSecond
Tuple
Validation
Data
Namespaces
Arr
functions
append
chunksOf
compact
concat
drop
dropWhile
every
filter
filterMap
findFirst
findIndex
findLast
flatMap
flatten
groupBy
head
init
insertAt
intersperse
last
map
mapWithIndex
partition
partitionMap
prepend
reduce
removeAt
reverse
scan
separate
size
some
sortBy
sortWith
splitAt
tail
take
takeWhile
uniq
uniqBy
uniqWith
zip
zipWith
namespaces
is
functions
empty
nonEmpty
sequence
variables
Maybe
Result
Task
traverse
variables
Maybe
Result
Task
type-aliases
NonEmpty
variables
NonEmpty
Dict
functions
compact
difference
empty
entries
filter
filterMap
filterWithKey
groupBy
has
insert
intersection
keys
lookup
map
mapWithKey
reduce
reduceWithKey
remove
singleton
size
union
upsert
values
namespaces
from
functions
entries
Record
is
functions
empty
nonEmpty
to
functions
Record
type-aliases
NonEmpty
variables
NonEmpty
Num
functions
abs
add
between
ceil
clamp
divide
floor
inRange
max
mean
min
multiply
negate
parse
range
remainder
round
subtract
sum
Rec
functions
compact
entries
filter
filterMap
filterWithKey
groupBy
keys
lookup
map
mapKeys
mapWithKey
merge
omit
pick
size
values
namespaces
from
functions
entries
is
functions
empty
variables
nonEmpty
sequence
variables
Maybe
Result
traverse
variables
Maybe
Result
type-aliases
NonEmpty
variables
NonEmpty
Str
functions
capitalize
endsWith
includes
isBlank
length
lines
padEnd
padStart
parseJson
replace
replaceAll
slice
split
startsWith
toLowerCase
toUpperCase
trim
words
namespaces
is
functions
empty
nonEmpty
type-aliases
NonEmpty
variables
NonEmpty
parse
Uniq
functions
difference
empty
filter
has
insert
intersection
isSubsetOf
map
reduce
remove
singleton
size
union
namespaces
from
functions
Array
is
functions
empty
nonEmpty
to
functions
Array
type-aliases
NonEmpty
variables
NonEmpty
Type Aliases
NonEmptyMap
NonEmptyRecord
NonEmptySet
NonEmptyString
Types
Namespaces
Brand
functions
unwrap
wrap
Duration
functions
add
days
hours
milliseconds
minutes
seconds
subtract
namespaces
to
functions
days
hours
milliseconds
minutes
seconds
Type Aliases
Brand
Duration
GitHub
npm
NonEmpty
NonEmpty
:
typeof
StrNonEmpty
Defined in:
Data/Str.ts:43