API reference

This reference describes the public API. Use the guides for explanations, decisions, and complete examples; use these pages when you know the feature you need.

Start with an overview

• Core types and helpers: Option, Result, Try, pipelines, and tagged unions.

• Collections: lazy sequences and immutable collections.

• Effects: generator-based and asynchronous workflows.

• Extras: parsers and helpers for optional and fallible values.

• System utilities: mailbox processing, cancellation, and disposables.

Detailed modules

The following generated pages list all public members by module:

• Option, Result, and Try

• Pipe, Pipeline, and Compose

• Seq, Block, Map, and TypedArray

• Tagged unions