TreasureTrails/node_modules/effect
2026-03-18 09:02:21 -05:00
..
.index Initial commit 2026-03-18 09:02:21 -05:00
Arbitrary Initial commit 2026-03-18 09:02:21 -05:00
Array Initial commit 2026-03-18 09:02:21 -05:00
BigDecimal Initial commit 2026-03-18 09:02:21 -05:00
BigInt Initial commit 2026-03-18 09:02:21 -05:00
Boolean Initial commit 2026-03-18 09:02:21 -05:00
Brand Initial commit 2026-03-18 09:02:21 -05:00
Cache Initial commit 2026-03-18 09:02:21 -05:00
Cause Initial commit 2026-03-18 09:02:21 -05:00
Channel Initial commit 2026-03-18 09:02:21 -05:00
ChildExecutorDecision Initial commit 2026-03-18 09:02:21 -05:00
Chunk Initial commit 2026-03-18 09:02:21 -05:00
Clock Initial commit 2026-03-18 09:02:21 -05:00
Config Initial commit 2026-03-18 09:02:21 -05:00
ConfigError Initial commit 2026-03-18 09:02:21 -05:00
ConfigProvider Initial commit 2026-03-18 09:02:21 -05:00
ConfigProviderPathPatch Initial commit 2026-03-18 09:02:21 -05:00
Console Initial commit 2026-03-18 09:02:21 -05:00
Context Initial commit 2026-03-18 09:02:21 -05:00
Cron Initial commit 2026-03-18 09:02:21 -05:00
Data Initial commit 2026-03-18 09:02:21 -05:00
DateTime Initial commit 2026-03-18 09:02:21 -05:00
DefaultServices Initial commit 2026-03-18 09:02:21 -05:00
Deferred Initial commit 2026-03-18 09:02:21 -05:00
Differ Initial commit 2026-03-18 09:02:21 -05:00
dist Initial commit 2026-03-18 09:02:21 -05:00
Duration Initial commit 2026-03-18 09:02:21 -05:00
Effect Initial commit 2026-03-18 09:02:21 -05:00
Effectable Initial commit 2026-03-18 09:02:21 -05:00
Either Initial commit 2026-03-18 09:02:21 -05:00
Encoding Initial commit 2026-03-18 09:02:21 -05:00
Equal Initial commit 2026-03-18 09:02:21 -05:00
Equivalence Initial commit 2026-03-18 09:02:21 -05:00
ExecutionPlan Initial commit 2026-03-18 09:02:21 -05:00
ExecutionStrategy Initial commit 2026-03-18 09:02:21 -05:00
Exit Initial commit 2026-03-18 09:02:21 -05:00
FastCheck Initial commit 2026-03-18 09:02:21 -05:00
Fiber Initial commit 2026-03-18 09:02:21 -05:00
FiberHandle Initial commit 2026-03-18 09:02:21 -05:00
FiberId Initial commit 2026-03-18 09:02:21 -05:00
FiberMap Initial commit 2026-03-18 09:02:21 -05:00
FiberRef Initial commit 2026-03-18 09:02:21 -05:00
FiberRefs Initial commit 2026-03-18 09:02:21 -05:00
FiberRefsPatch Initial commit 2026-03-18 09:02:21 -05:00
FiberSet Initial commit 2026-03-18 09:02:21 -05:00
FiberStatus Initial commit 2026-03-18 09:02:21 -05:00
Function Initial commit 2026-03-18 09:02:21 -05:00
GlobalValue Initial commit 2026-03-18 09:02:21 -05:00
Graph Initial commit 2026-03-18 09:02:21 -05:00
GroupBy Initial commit 2026-03-18 09:02:21 -05:00
Hash Initial commit 2026-03-18 09:02:21 -05:00
HashMap Initial commit 2026-03-18 09:02:21 -05:00
HashSet Initial commit 2026-03-18 09:02:21 -05:00
HKT Initial commit 2026-03-18 09:02:21 -05:00
index Initial commit 2026-03-18 09:02:21 -05:00
Inspectable Initial commit 2026-03-18 09:02:21 -05:00
Iterable Initial commit 2026-03-18 09:02:21 -05:00
JSONSchema Initial commit 2026-03-18 09:02:21 -05:00
KeyedPool Initial commit 2026-03-18 09:02:21 -05:00
Layer Initial commit 2026-03-18 09:02:21 -05:00
LayerMap Initial commit 2026-03-18 09:02:21 -05:00
List Initial commit 2026-03-18 09:02:21 -05:00
Logger Initial commit 2026-03-18 09:02:21 -05:00
LogLevel Initial commit 2026-03-18 09:02:21 -05:00
LogSpan Initial commit 2026-03-18 09:02:21 -05:00
Mailbox Initial commit 2026-03-18 09:02:21 -05:00
ManagedRuntime Initial commit 2026-03-18 09:02:21 -05:00
Match Initial commit 2026-03-18 09:02:21 -05:00
MergeDecision Initial commit 2026-03-18 09:02:21 -05:00
MergeState Initial commit 2026-03-18 09:02:21 -05:00
MergeStrategy Initial commit 2026-03-18 09:02:21 -05:00
Metric Initial commit 2026-03-18 09:02:21 -05:00
MetricBoundaries Initial commit 2026-03-18 09:02:21 -05:00
MetricHook Initial commit 2026-03-18 09:02:21 -05:00
MetricKey Initial commit 2026-03-18 09:02:21 -05:00
MetricKeyType Initial commit 2026-03-18 09:02:21 -05:00
MetricLabel Initial commit 2026-03-18 09:02:21 -05:00
MetricPair Initial commit 2026-03-18 09:02:21 -05:00
MetricPolling Initial commit 2026-03-18 09:02:21 -05:00
MetricRegistry Initial commit 2026-03-18 09:02:21 -05:00
MetricState Initial commit 2026-03-18 09:02:21 -05:00
Micro Initial commit 2026-03-18 09:02:21 -05:00
ModuleVersion Initial commit 2026-03-18 09:02:21 -05:00
MutableHashMap Initial commit 2026-03-18 09:02:21 -05:00
MutableHashSet Initial commit 2026-03-18 09:02:21 -05:00
MutableList Initial commit 2026-03-18 09:02:21 -05:00
MutableQueue Initial commit 2026-03-18 09:02:21 -05:00
MutableRef Initial commit 2026-03-18 09:02:21 -05:00
NonEmptyIterable Initial commit 2026-03-18 09:02:21 -05:00
Number Initial commit 2026-03-18 09:02:21 -05:00
Option Initial commit 2026-03-18 09:02:21 -05:00
Order Initial commit 2026-03-18 09:02:21 -05:00
Ordering Initial commit 2026-03-18 09:02:21 -05:00
ParseResult Initial commit 2026-03-18 09:02:21 -05:00
Pipeable Initial commit 2026-03-18 09:02:21 -05:00
Pool Initial commit 2026-03-18 09:02:21 -05:00
Predicate Initial commit 2026-03-18 09:02:21 -05:00
Pretty Initial commit 2026-03-18 09:02:21 -05:00
PrimaryKey Initial commit 2026-03-18 09:02:21 -05:00
PubSub Initial commit 2026-03-18 09:02:21 -05:00
Queue Initial commit 2026-03-18 09:02:21 -05:00
Random Initial commit 2026-03-18 09:02:21 -05:00
RateLimiter Initial commit 2026-03-18 09:02:21 -05:00
RcMap Initial commit 2026-03-18 09:02:21 -05:00
RcRef Initial commit 2026-03-18 09:02:21 -05:00
Readable Initial commit 2026-03-18 09:02:21 -05:00
Record Initial commit 2026-03-18 09:02:21 -05:00
Redacted Initial commit 2026-03-18 09:02:21 -05:00
RedBlackTree Initial commit 2026-03-18 09:02:21 -05:00
Ref Initial commit 2026-03-18 09:02:21 -05:00
RegExp Initial commit 2026-03-18 09:02:21 -05:00
Reloadable Initial commit 2026-03-18 09:02:21 -05:00
Request Initial commit 2026-03-18 09:02:21 -05:00
RequestBlock Initial commit 2026-03-18 09:02:21 -05:00
RequestResolver Initial commit 2026-03-18 09:02:21 -05:00
Resource Initial commit 2026-03-18 09:02:21 -05:00
Runtime Initial commit 2026-03-18 09:02:21 -05:00
RuntimeFlags Initial commit 2026-03-18 09:02:21 -05:00
RuntimeFlagsPatch Initial commit 2026-03-18 09:02:21 -05:00
Schedule Initial commit 2026-03-18 09:02:21 -05:00
ScheduleDecision Initial commit 2026-03-18 09:02:21 -05:00
ScheduleInterval Initial commit 2026-03-18 09:02:21 -05:00
ScheduleIntervals Initial commit 2026-03-18 09:02:21 -05:00
Scheduler Initial commit 2026-03-18 09:02:21 -05:00
Schema Initial commit 2026-03-18 09:02:21 -05:00
SchemaAST Initial commit 2026-03-18 09:02:21 -05:00
Scope Initial commit 2026-03-18 09:02:21 -05:00
ScopedCache Initial commit 2026-03-18 09:02:21 -05:00
ScopedRef Initial commit 2026-03-18 09:02:21 -05:00
Secret Initial commit 2026-03-18 09:02:21 -05:00
SingleProducerAsyncInput Initial commit 2026-03-18 09:02:21 -05:00
Sink Initial commit 2026-03-18 09:02:21 -05:00
SortedMap Initial commit 2026-03-18 09:02:21 -05:00
SortedSet Initial commit 2026-03-18 09:02:21 -05:00
src Initial commit 2026-03-18 09:02:21 -05:00
STM Initial commit 2026-03-18 09:02:21 -05:00
Stream Initial commit 2026-03-18 09:02:21 -05:00
Streamable Initial commit 2026-03-18 09:02:21 -05:00
StreamEmit Initial commit 2026-03-18 09:02:21 -05:00
StreamHaltStrategy Initial commit 2026-03-18 09:02:21 -05:00
String Initial commit 2026-03-18 09:02:21 -05:00
Struct Initial commit 2026-03-18 09:02:21 -05:00
Subscribable Initial commit 2026-03-18 09:02:21 -05:00
SubscriptionRef Initial commit 2026-03-18 09:02:21 -05:00
Supervisor Initial commit 2026-03-18 09:02:21 -05:00
Symbol Initial commit 2026-03-18 09:02:21 -05:00
SynchronizedRef Initial commit 2026-03-18 09:02:21 -05:00
Take Initial commit 2026-03-18 09:02:21 -05:00
TArray Initial commit 2026-03-18 09:02:21 -05:00
TDeferred Initial commit 2026-03-18 09:02:21 -05:00
TestAnnotation Initial commit 2026-03-18 09:02:21 -05:00
TestAnnotationMap Initial commit 2026-03-18 09:02:21 -05:00
TestAnnotations Initial commit 2026-03-18 09:02:21 -05:00
TestClock Initial commit 2026-03-18 09:02:21 -05:00
TestConfig Initial commit 2026-03-18 09:02:21 -05:00
TestContext Initial commit 2026-03-18 09:02:21 -05:00
TestLive Initial commit 2026-03-18 09:02:21 -05:00
TestServices Initial commit 2026-03-18 09:02:21 -05:00
TestSized Initial commit 2026-03-18 09:02:21 -05:00
TMap Initial commit 2026-03-18 09:02:21 -05:00
TPriorityQueue Initial commit 2026-03-18 09:02:21 -05:00
TPubSub Initial commit 2026-03-18 09:02:21 -05:00
TQueue Initial commit 2026-03-18 09:02:21 -05:00
Tracer Initial commit 2026-03-18 09:02:21 -05:00
TRandom Initial commit 2026-03-18 09:02:21 -05:00
TReentrantLock Initial commit 2026-03-18 09:02:21 -05:00
TRef Initial commit 2026-03-18 09:02:21 -05:00
Trie Initial commit 2026-03-18 09:02:21 -05:00
TSemaphore Initial commit 2026-03-18 09:02:21 -05:00
TSet Initial commit 2026-03-18 09:02:21 -05:00
TSubscriptionRef Initial commit 2026-03-18 09:02:21 -05:00
Tuple Initial commit 2026-03-18 09:02:21 -05:00
Types Initial commit 2026-03-18 09:02:21 -05:00
Unify Initial commit 2026-03-18 09:02:21 -05:00
UpstreamPullRequest Initial commit 2026-03-18 09:02:21 -05:00
UpstreamPullStrategy Initial commit 2026-03-18 09:02:21 -05:00
Utils Initial commit 2026-03-18 09:02:21 -05:00
LICENSE Initial commit 2026-03-18 09:02:21 -05:00
package.json Initial commit 2026-03-18 09:02:21 -05:00
README.md Initial commit 2026-03-18 09:02:21 -05:00

effect Core Package

The effect package is the heart of the Effect framework, providing robust primitives for managing side effects, ensuring type safety, and supporting concurrency in your TypeScript applications.

Requirements

  • TypeScript 5.4 or Newer: Ensure you are using a compatible TypeScript version.

  • Strict Type-Checking: The strict flag must be enabled in your tsconfig.json. For example:

    {
      "compilerOptions": {
        "strict": true
        // ...other options
      }
    }
    

Installation

Install the core package using your preferred package manager. For example, with npm:

npm install effect

Documentation

Overview of Effect Modules

The effect package provides a collection of modules designed for functional programming in TypeScript. Below is a brief overview of the core modules:

Module Description
Effect The core abstraction for managing side effects, concurrency, and error handling in a structured way.
Context A lightweight dependency injection mechanism that enables passing services through computations without direct references.
Layer A system for managing dependencies, allowing for modular and composable resource allocation.
Fiber Lightweight virtual threads with resource-safe cancellation capabilities, enabling many features in Effect.
Stream A powerful abstraction for handling asynchronous, event-driven data processing.
Schedule A module for defining retry and repeat policies with composable schedules.
Scope Manages the lifecycle of resources, ensuring proper acquisition and release.
Schema A powerful library for defining, validating, and transforming structured data with type-safe encoding and decoding.

For a comparison between effect/Schema and zod, see Schema vs Zod.