Back to Effect

Introduction

docs/index.md

latest9.8 KB
Original Source

Effect Monorepo

An ecosystem of tools to build robust applications in TypeScript

Introduction

Welcome to Effect, a powerful TypeScript framework that provides a fully-fledged functional effect system with a rich standard library.

Effect consists of several packages that work together to help build robust TypeScript applications. The core package, effect, serves as the foundation of the framework, offering primitives for managing side effects, ensuring type safety, and supporting concurrency.

Monorepo Structure

The Effect monorepo is organized into multiple packages, each extending the core functionality. Below is an overview of the packages included:

PackageDescription
effectCore packageREADME
@effect/aiAI utilitiesREADME
@effect/ai-openaiOpenAI utilitiesREADME
@effect/cliCLI utilitiesREADME
@effect/clusterDistributed computing toolsREADME
@effect/cluster-browserCluster utilities for the browserREADME
@effect/cluster-nodeCluster utilities for Node.jsREADME
@effect/cluster-workflowWorkflow management for clustersREADME
@effect/experimentalExperimental features and APIsREADME
@effect/opentelemetryOpenTelemetry integrationREADME
@effect/platformCross-platform runtime utilitiesREADME
@effect/platform-browserPlatform utilities for the browserREADME
@effect/platform-bunPlatform utilities for BunREADME
@effect/platform-nodePlatform utilities for Node.jsREADME
@effect/platform-node-sharedShared utilities for Node.jsREADME
@effect/printerGeneral-purpose printing utilitiesREADME
@effect/printer-ansiANSI-compatible printing utilitiesREADME
@effect/rpcRemote procedure call (RPC) utilitiesREADME
@effect/rpc-httpHTTP-based RPC utilitiesREADME
@effect/sqlSQL database utilitiesREADME
@effect/sql-clickhouseAn @effect/sql implementation for ClickHouse.README
@effect/sql-d1An @effect/sql implementation for Cloudflare D1.README
@effect/sql-drizzleAn @effect/sql implementation for Drizzle.README
@effect/sql-kyselyAn @effect/sql implementation for Kysely.README
@effect/sql-libsqlAn @effect/sql implementation using the @libsql/client library.README
@effect/sql-mssqlAn @effect/sql implementation using the mssql tedious library.README
@effect/sql-mysql2An @effect/sql implementation using the mysql2 library.README
@effect/sql-pgAn @effect/sql implementation using the postgres.js library.README
@effect/sql-sqlite-bunAn @effect/sql implementation using the bun:sqlite library.README
@effect/sql-sqlite-doAn @effect/sql implementation for Cloudflare Durable Objects sqlite storage.README
@effect/sql-sqlite-nodeAn @effect/sql implementation using the better-sqlite3 library.README
@effect/sql-sqlite-react-nativeAn @effect/sql implementation using the react-native-quick-sqlite library.README
@effect/sql-sqlite-wasmAn @effect/sql implementation using the @sqlite.org/sqlite-wasm library.README
@effect/typeclassFunctional programming type classesREADME
@effect/vitestTesting utilities for VitestREADME

Documentation

Website

For detailed information and usage examples, visit the Effect website.

API Reference

For a complete API reference of the core package effect, see the Effect API documentation.

Introduction to Effect

Get started with Effect by watching our introductory video on YouTube. This video provides an overview of Effect and its key features:

Connect with Our Community

Join the Effect community on Discord to connect with other developers, ask questions, and share insights: Join Effect's Discord Community.