Skip to content

igorjs/pure-fx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

238 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Pure FX

CI npm npm downloads JSR License Zero Dependencies

Functional application framework for TypeScript. Zero dependencies.

Note: This project is in beta. APIs may change between minor versions until 1.0.

Errors are values, not exceptions. Data is immutable, enforced at runtime. Async is lazy and composable.

Runs on Node.js 22+, Deno 2+, Bun, Cloudflare Workers, and Chromium.

Install

npm install @igorjs/pure-fx

Also available on JSR:

npx jsr add @igorjs/pure-fx

Quick Example

import { Ok, Err, pipe, Task, Schema, File, Valid, Invalid } from '@igorjs/pure-fx'

// Errors as values, not exceptions
const parse = (s: string) => {
  const n = Number(s);
  return Number.isNaN(n) ? Err('not a number') : Ok(n);
};

pipe(parse('42'), r => r.map(n => n * 2)); // Ok(84)

// Lazy async with Result
const data = await Task.fromPromise(() => fetch('/api'), String)
  .map(r => r.json())
  .timeout(5000, () => 'timed out')
  .run(); // Result<unknown, string>

// Validate unknown input
const User = Schema.object({ name: Schema.string, age: Schema.number });
User.parse(untrustedData); // Result<{ name: string; age: number }, SchemaError>

// Accumulate ALL validation errors (not just the first)
const validateName = (s: string) => s ? Valid(s) : Invalid('name required');
const validateAge = (n: number) => n > 0 ? Valid(n) : Invalid('must be positive');
validateName('').zip(validateAge(-1)); // Invalid(['name required', 'must be positive'])

// Read a file (works on Node, Deno, Bun)
const content = await File.read('./config.json').run();

Modules

Layer Primitives Docs
Core Result, Option, Validation, pipe, flow, Match, Eq, Ord, State, Lens, Prism, Iso, Traversal, LensOptional docs/core.md
Data Record, List, NonEmptyList, HashMap, Immutable, Schema, Codec, ADT, StableVec docs/data.md
Types TypeDef (+ Str, Num, Int, UInt, Bool, Bytes, Nil, DateTime, Vec, Pair, Tuple, Dict, Struct, ListOf, MapOf, Maybe, Either), ErrType, Type, Duration, Cron docs/types.md
Async Task, Stream, Lazy, Env, Timer, Retry, CircuitBreaker, Semaphore, Mutex, RateLimiter, Cache, Channel, StateMachine, EventEmitter, Pool, Queue, CronRunner docs/async.md
IO File, Command, Json, Crypto, Encoding, Compression, Clone, Url, Client, Terminal, WebSocket, Dns, Net, FFI docs/io.md
Runtime Server, Program, Logger, Config, Os, Process, Path, Eol, Platform docs/runtime.md

Full documentation with examples

Runtime Compatibility

Most modules are pure TypeScript and work everywhere. Runtime-dependent modules adapt automatically:

Module Node 22+ Node 25+ Deno 2+ Bun Workers Browser
Core, Data, Async, Types Yes Yes Yes Yes Yes Yes
Crypto (full Web Crypto) Yes Yes Yes Yes Yes Yes
Compression Yes Yes Yes Yes Partial Partial
File, Command, Terminal Yes Yes Yes Yes No No
Process, Os, Path Yes Yes Yes Yes No No
Dns, Net Yes Yes Yes Yes No No
FFI No Yes (--allow-ffi) Yes (--allow-ffi) Yes No No
Server Yes Yes Yes Yes Yes (adapter) No

Troubleshooting

Compression hangs on older Deno versions

Pure FX uses Blob.stream().pipeThrough() for compression, which requires Deno 1.38+. If compression operations hang, update Deno.

FFI not available

FFI requires native library loading capabilities:

  • Deno: Run with --allow-ffi
  • Bun: Works out of the box
  • Node 25+: Run with --allow-ffi (experimental)
  • Node 22-24: Not available. FFI.open() returns Err(FFIError("...")). Use FFI.isAvailable() to check.

Os/Process return None for some values

Some OS APIs are permission-gated on Deno (e.g. hostname, env). Run with --allow-sys and --allow-env, or use deno run --allow-all.

On Windows, Process.uid() and Process.gid() return None (POSIX-only APIs).

File operations return Err

All file operations return Result or Task instead of throwing. Check the error:

const result = await File.read('./missing.txt').run();
if (result.isErr) {
  console.log(result.error.tag);     // "FileError"
  console.log(result.error.message); // "ENOENT: no such file..."
}

Deno requires version 2.0+

Pure FX uses Deno 2.0+ APIs. Deno 1.x is not supported. Compression requires Deno 1.38+ for CompressionStream, but all other modules require Deno 2.0+.

Modules return Err in Workers/Browser

Runtime-dependent modules (File, Command, Process, etc.) gracefully return Err or None in environments that don't support them. They never throw.

Subpath Imports

// Import everything
import { Ok, Task, Schema } from '@igorjs/pure-fx'

// Or import specific modules for smaller bundles
import { Ok, Err, pipe } from '@igorjs/pure-fx/core'
import { Schema, HashMap } from '@igorjs/pure-fx/data'
import { Task, Stream } from '@igorjs/pure-fx/async'
import { File, Command, FFI } from '@igorjs/pure-fx/io'

How It Compares

Pure FX Effect fp-ts / Effect-ts
Philosophy Thin, opt-in primitives Comprehensive runtime with fibers, layers, services Category-theory encodings (HKT, typeclasses)
Dependencies Zero ~10 internal packages Several (fp-ts ecosystem)
Learning curve Familiar JS idioms (Result, Option, pipe) Steep: generators, layers, services, scopes Steep: HKT, Kind, typeclass instances
Bundle size Small, tree-shakeable subpaths Large (full runtime) Medium
Error handling Result<T, E> and Task<T, E> Typed errors via Effect<A, E, R> Either<E, A>, TaskEither
Async Task (lazy Promise wrapper) Fiber-based with structured concurrency TaskEither, ReaderTaskEither
Runtime support Node, Deno, Bun, Workers, Browser Node (primary), limited Deno/Bun Node (primary)
IO Built-in File, Command, Server, Crypto, FFI Via services and layers BYO (no IO primitives)

Choose Pure FX when you want typed errors and immutable data without adopting a framework. It adds Result, Task, Schema, and IO adapters on top of plain TypeScript: no generators, no layers, no HKT. If your code already uses pipe and explicit error returns, Pure FX fits in without reshaping your architecture.

Choose Effect when you need structured concurrency, dependency injection via layers, or a full application runtime with fibers, scopes, and managed services.

Choose fp-ts when you want strict category-theory abstractions and are comfortable with HKT-based typeclass hierarchies.

Contributing

See CONTRIBUTING.md for development setup, coding standards, and how to submit changes.

Disclaimer

THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

License

Apache-2.0

About

Functional application framework for TypeScript. Zero dependencies. Errors as values. Immutability at runtime.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages

 
 
 

Contributors