Skip to content
Source
Sign inSign up

.repos/effect

README.md

pkg.pr.new

Effect

Effect is a library for building robust, maintainable, type-safe, and production grade applications in TypeScript. It helps you handle the hard problems at scale: typed errors, dependency injection, structured concurrency, scheduling, tracing, and unified schema validation.

Effect 4.x is a long-term support (LTS) release. If you are upgrading from Effect 3.x, follow the migration guide.

Installation

npm install effect

Requirements

  • TypeScript 5.9 or newer. TypeScript 7 is recommended for the best performance and compatibility with Effect's TypeScript tooling.
  • Node.js 22.19 or newer is the general minimum for running Effect on Node.js.
  • Strict type-checking: the strict flag must be enabled in your tsconfig.json.
  • Website: documentation, guides, and news
  • Discord: ask questions, share what you're building, and talk to the core team
  • Community: meetups and events, or bring Effect to your own
  • Issues: bug reports and feature requests
  • Jobs: companies hiring Effect developers
  • Follow us on X, Bluesky, and LinkedIn

Let's talk

Whether your team is considering Effect, rolling it out, or already running it in production, we'd love to hear from you: what you're building, what works, and what you need from Effect next.

  • Talk to the maintainers. Introduce your team on Discord or email contact@effectful.co. We're happy to connect privately on Slack or Discord for feedback and help with adoption.
  • Production support. We're exploring how to better support teams running Effect in production. If your organization has specific support needs, let's discuss them.
  • Adoption help. Our adoption partners offer implementation, consulting, team extension, training, and commercial support.

Feedback from teams using and evaluating Effect directly shapes what we stabilize and build next.

Long-term support

Teams depend on Effect for systems they expect to run for years. Effect 4.x is a long-term support (LTS) release with the following guarantees:

  • At least three years of support, including bug and security fixes.
  • Bug fixes for one year after the next major version is released.
  • Security fixes for two years after the next major version is released.

Stable APIs reserve breaking changes for major releases. APIs marked unstable may change in minor releases, and experimental APIs may change in patch releases.

Effect v3

The Effect v3 source code is available on the v3 branch, which is also where issues and pull requests meant for Effect v3 should be targeted. To upgrade, see the migration guide.

Packages

This monorepo contains the core effect package alongside integration packages that extend it. All packages listed below are released together with synchronized versions.

PackageDescriptionAPI Reference
effectThe core packagedocs
@effect/platform-browserPlatform services for the browserdocs
@effect/platform-bunPlatform services for Bundocs
@effect/platform-denoPlatform services for Denodocs
@effect/platform-nodePlatform services for Node.jsdocs
@effect/platform-node-sharedShared services for Node.js-compatible runtimesdocs
@effect/sql-clickhouseSQL client for ClickHousedocs
@effect/sql-d1SQL client for Cloudflare D1docs
@effect/sql-libsqlSQL client for libSQLdocs
@effect/sql-mssqlSQL client for Microsoft SQL Serverdocs
@effect/sql-mysql2SQL client for MySQLdocs
@effect/sql-pgSQL client for PostgreSQLdocs
@effect/sql-pgliteSQL client for PGlitedocs
@effect/sql-sqlite-bunSQL client for SQLite via bun:sqlitedocs
@effect/sql-sqlite-doSQL client for Cloudflare Durable Objects SQLitedocs
@effect/sql-sqlite-nodeSQL client for SQLite via node:sqlitedocs
@effect/sql-sqlite-react-nativeSQL client for SQLite in React Nativedocs
@effect/sql-sqlite-wasmSQL client for SQLite compiled to WebAssemblydocs
@effect/ai-anthropicAnthropic provider for the Effect AI modulesdocs
@effect/ai-openaiOpenAI provider for the Effect AI modulesdocs
@effect/ai-cloudflareCloudflare decision provider for the Effect AI modulesdocs
@effect/ai-typesafeTypeSafe decision provider for the Effect AI modulesdocs
@effect/ai-openai-compatOpenAI-compatible API provider for the Effect AI modulesdocs
@effect/ai-openrouterOpenRouter provider for the Effect AI modulesdocs
@effect/atom-reactReact bindings for Effect Atomdocs
@effect/atom-solidSolidJS bindings for Effect Atomdocs
@effect/atom-vueVue bindings for Effect Atomdocs
@effect/opentelemetryOpenTelemetry integrationdocs
@effect/vitestHelpers for testing with Vitestdocs
@effect/docgenDocumentation generator for Effect projectsdocs
@effect/doctestRuns JSDoc examples as Vitest testsdocs
@effect/openapi-generatorGenerate Effect code from OpenAPI specificationsdocs
@effect/graphql-generatorGenerate Effect code from GraphQL documentsdocs

License

MIT