Skip to content
pipelined
Docs
Contributing
Search
Ctrl
K
Cancel
GitHub
npm
The basics
Installation
Thinking in pipelines
Designing with states
Reading the Types
Choosing a Container
Composition utilities
Recipes
A Request Lifecycle
Per-Field Validation with Visibility
A Dependency Graph
Events and State
Errors & absence
Maybe — Explicit Absence
Result — Modeling Failures
Validation — Accumulating Errors
Data containers
Pair — Values That Travel Together
These — One Value or Both
RemoteData — Loading States
Async
Task — Lazy Asynchronous Work
Deferred — Awaitable Async Values
Aborted — Cancellation Outcomes
Op — Managing Async Operations
CircuitBreaker — Protecting a Dependency
RateLimiter — Staying Inside a Quota
Batcher — Batched Key Lookups
Cache — Reusing Recent Results
EventBus — Typed Event Delivery
Resource — Acquisition and Cleanup
Graph — Dependent Async Tasks
Transaction — Steps and Compensation
Supervisor — Keeping a Worker Running
State & context
Reader — Shared Environment
State — Sequential State Updates
Machine — States and Transitions
Logged — Values with a Log
Optics
Lens — Required Nested Values
Optional — Values That May Be Missing
Type safety
Brand — Distinguishing Values
Duration — Time Quantities
Non-Empty Collections
Refinement — Composing Type Guards
Predicate — Combining Checks
Comparing & combining
Equality — Comparing Values
Ordering — Comparing Sort Order
Combinable — Combining Values
Collection utilities
Arr — Array Utilities
Str — String Utilities
Num — Number Utilities
BigNum — BigInt Utilities
Bool — Boolean Utilities
Rec — Record Utilities
Dict — Map Utilities
Uniq — Set Utilities
Json — Parsing and Serialization
Appendix
Design Notes
Performance and benchmarks
Contributing
Contributor Handbook
Local Workflow
Testing
Adding a Module
Writing Guides
API Reference
Composition
Namespaces
tapAsync
type-aliases
Options
tapInspect
type-aliases
Options
tapLog
type-aliases
Options
tapTime
type-aliases
Config
Functions
constant
converge
curry
flip
flow
flowAsync
identity
juxt
memoize
memoizeWeak
on
once
pipe
pipeAsync
struct
tap
tapAsync
tapInspect
tapLog
tapTime
tuple
uncurry
unless
untuple
when
Core
Namespaces
Batcher
type-aliases
Err
Missing
Ok
Options
Outcome
Cache
type-aliases
Config
CircuitBreaker
type-aliases
ClosedState
Config
HalfOpenState
OpenError
OpenState
State
EventBus
type-aliases
CollectedPayloads
ForwardOptions
Message
Options
SequenceOptions
Subscription
Graph
type-aliases
AnyNode
DepsErrors
DepsOutputs
ErrorOf
MakeOptions
Node
NodeFactory
NodeRun
OutputOf
RunOptions
Machine
type-aliases
Actor
EntryContext
EventMessage
InterpretOptions
State
StateConfig
TransitionHandler
TransitionTable
Maybe
type-aliases
None
Some
Op
type-aliases
AbortedNil
BufferedState
ConcurrentDropState
ConcurrentQueueState
DebouncedState
DroppedNil
Err
EvictedNil
ExclusiveState
Idle
InterpretOptions
KeyedExclusivePerKey
KeyedManager
KeyedRestartablePerKey
Manager
Nil
NilReason
Ok
OnceState
Outcome
Overflow
Pending
PerKey
Queued
QueueDropAndReplaceState
QueueDropState
QueueReplaceState
QueueState
ReplacedNil
RestartableState
RetryableBufferedState
RetryableConcurrentDropState
RetryableConcurrentQueueState
RetryableDebouncedState
RetryableExclusiveState
RetryableOnceState
RetryableQueueDropAndReplaceState
RetryableQueueDropState
RetryableQueueReplaceState
RetryableQueueState
RetryableRestartableState
RetryableThrottledState
RetryableThrottledTrailingState
Retrying
RetryOptions
State
Strategy
ThrottledState
ThrottledTrailingState
TimeoutOptions
ToArgs
RateLimiter
type-aliases
Config
LimitError
RemoteData
type-aliases
Failure
Loading
NotAsked
Success
Result
type-aliases
Err
Ok
Supervisor
type-aliases
BackingOff
Failed
Idle
Running
State
Stopped
Task
type-aliases
LabeledTask
Maybe
Result
Validation
These
type-aliases
Both
First
Second
Transaction
type-aliases
AnyStep
DependencyOutputs
Failure
OutputOf
RunOptions
Step
StepFactory
StepRun
StepUndo
UndoFailure
Validation
type-aliases
Failed
KeyedErrors
KeyedInput
KeyedResult
KeyedResultOf
Passed
ValidatorInput
Type Aliases
Aborted
Batcher
Cache
CircuitBreaker
Combinable
Deferred
Equality
EventBus
Graph
Lens
Logged
Machine
Maybe
Op
Optional
Ordering
Pair
Predicate
RateLimiter
Reader
Refinement
RemoteData
Resource
Result
State
Supervisor
Task
These
Transaction
Validation
Variables
Aborted
Batcher
Cache
CircuitBreaker
Combinable
Deferred
Equality
EventBus
Graph
Lens
Logged
Machine
Maybe
Op
Optional
Ordering
Pair
Predicate
RateLimiter
Reader
Refinement
RemoteData
Resource
Result
State
Supervisor
Task
These
Transaction
Validation
Data
Namespaces
Arr
type-aliases
NonEmpty
Dict
type-aliases
NonEmpty
Rec
type-aliases
NonEmpty
Str
type-aliases
NonEmpty
Uniq
type-aliases
NonEmpty
Variables
Arr
BigNum
Bool
Dict
Json
Num
Rec
Str
Uniq
Types
Namespaces
RetryPolicy
type-aliases
Metadata
Type Aliases
Brand
Duration
RetryPolicy
Variables
Brand
Duration
RetryPolicy
GitHub
npm
@pplnd/core
Modules
Section titled “Modules”
Composition
Core
Data
Types
