effect__ai__AiError.yaml

effect__ai__Chat.yaml

effect__ai__EmbeddingModel.yaml

effect__ai__IdGenerator.yaml

effect__ai__index.yaml

effect__ai__LanguageModel.yaml

effect__ai__McpSchema.yaml

effect__ai__McpServer.yaml

effect__ai__Model.yaml

effect__ai__Prompt.yaml

effect__ai__Response.yaml

effect__ai__Telemetry.yaml

effect__ai__Tool.yaml

effect__ai__Toolkit.yaml

effect__ai-amazon-bedrock__AmazonBedrockClient.yaml

effect__ai-amazon-bedrock__AmazonBedrockConfig.yaml

effect__ai-amazon-bedrock__AmazonBedrockLanguageModel.yaml

effect__ai-amazon-bedrock__AmazonBedrockSchema.yaml

effect__ai-amazon-bedrock__AmazonBedrockTool.yaml

effect__ai-amazon-bedrock__EventStreamEncoding.yaml

effect__ai-amazon-bedrock__index.yaml

effect__ai-amazon-bedrock.yaml

effect__ai-anthropic__AnthropicClient.yaml

effect__ai-anthropic__AnthropicConfig.yaml

effect__ai-anthropic__AnthropicLanguageModel.yaml

effect__ai-anthropic__AnthropicTokenizer.yaml

effect__ai-anthropic__AnthropicTool.yaml

effect__ai-anthropic__Generated.yaml

effect__ai-anthropic__index.yaml

effect__ai-google__Generated.yaml

effect__ai-google__GoogleClient.yaml

effect__ai-google__GoogleConfig.yaml

effect__ai-google__GoogleLanguageModel.yaml

effect__ai-google__GoogleTool.yaml

effect__ai-google__index.yaml

effect__ai-google.yaml

effect__ai-openai__Generated.yaml

effect__ai-openai__index.yaml

effect__ai-openai__OpenAiClient.yaml

effect__ai-openai__OpenAiConfig.yaml

effect__ai-openai__OpenAiEmbeddingModel.yaml

effect__ai-openai__OpenAiLanguageModel.yaml

effect__ai-openai__OpenAiTelemetry.yaml

effect__ai-openai__OpenAiTokenizer.yaml

effect__ai-openai__OpenAiTool.yaml

effect__ai-openrouter__Generated.yaml

effect__ai-openrouter__index.yaml

effect__ai-openrouter__OpenRouterClient.yaml

effect__ai-openrouter__OpenRouterConfig.yaml

effect__ai-openrouter__OpenRouterLanguageModel.yaml

effect__ai.yaml

effect__Arbitrary.yaml

effect__Array.yaml

effect__BigDecimal.yaml

effect__ChildExecutorDecision.yaml

effect__Chunk.yaml

effect__cli__Args.yaml

effect__cli__AutoCorrect.yaml

effect__cli__BuiltInOptions.yaml

effect__cli__CliApp.yaml

effect__cli__CliConfig.yaml

effect__cli__Command.yaml

effect__cli__CommandDescriptor.yaml

effect__cli__CommandDirective.yaml

effect__cli__ConfigFile.yaml

effect__cli__HelpDoc__Span.yaml

effect__cli__HelpDoc.yaml

effect__cli__index.yaml

effect__cli__Options.yaml

effect__cli__Primitive.yaml

effect__cli__Prompt.yaml

effect__cli__Usage.yaml

effect__cli__ValidationError.yaml

effect__cli.yaml

effect__Clock.yaml

effect__cluster__ClusterCron.yaml

effect__cluster__ClusterError.yaml

effect__cluster__ClusterSchema.yaml

effect__cluster__ClusterWorkflowEngine.yaml

effect__cluster__DeliverAt.yaml

effect__cluster__Entity.yaml

effect__cluster__EntityAddress.yaml

effect__cluster__EntityId.yaml

effect__cluster__EntityProxy.yaml

effect__cluster__EntityProxyServer.yaml

effect__cluster__EntityResource.yaml

effect__cluster__Envelope.yaml

effect__cluster__HttpRunner.yaml

effect__cluster__index.yaml

effect__cluster__K8sHttpClient.yaml

effect__cluster__MachineId.yaml

effect__cluster__Message.yaml

effect__cluster__MessageStorage.yaml

effect__cluster__Reply.yaml

effect__cluster__Runner.yaml

effect__cluster__RunnerAddress.yaml

effect__cluster__RunnerHealth.yaml

effect__cluster__Runners.yaml

effect__cluster__RunnerServer.yaml

effect__cluster__RunnerStorage.yaml

effect__cluster__ShardId.yaml

effect__cluster__Sharding.yaml

effect__cluster__ShardingConfig.yaml

effect__cluster__ShardingRegistrationEvent.yaml

effect__cluster__SingleRunner.yaml

effect__cluster__Singleton.yaml

effect__cluster__SingletonAddress.yaml

effect__cluster__Snowflake.yaml

effect__cluster__SocketRunner.yaml

effect__cluster__SqlMessageStorage.yaml

effect__cluster__SqlRunnerStorage.yaml

effect__cluster__TestRunner.yaml

effect__cluster.yaml

effect__Config.yaml

effect__ConfigError.yaml

effect__ConfigProvider.yaml

effect__ConfigProviderPathPatch.yaml

effect__DateTime.yaml

effect__DefaultServices.yaml

effect__Deferred.yaml

effect__Differ.yaml

effect__Duration.yaml

effect__Effect.yaml

effect__Effectable.yaml

effect__Either.yaml

effect__Encoding.yaml

effect__Equal.yaml

effect__Equivalence.yaml

effect__ExecutionPlan.yaml

effect__ExecutionStrategy.yaml

effect__Exit.yaml

effect__experimental__DevTools__Client.yaml

effect__experimental__DevTools__Domain.yaml

effect__experimental__DevTools__Server.yaml

effect__experimental__DevTools.yaml

effect__experimental__Event.yaml

effect__experimental__EventGroup.yaml

effect__experimental__EventJournal.yaml

effect__experimental__EventLog.yaml

effect__experimental__EventLogEncryption.yaml

effect__experimental__EventLogRemote.yaml

effect__experimental__EventLogServer__Cloudflare.yaml

effect__experimental__EventLogServer.yaml

effect__experimental__index.yaml

effect__experimental__Machine__Procedure.yaml

effect__experimental__Machine__ProcedureList.yaml

effect__experimental__Machine__SerializableProcedureList.yaml

effect__experimental__Machine.yaml

effect__experimental__PersistedCache.yaml

effect__experimental__PersistedQueue__Redis.yaml

effect__experimental__PersistedQueue.yaml

effect__experimental__Persistence__Lmdb.yaml

effect__experimental__Persistence__Redis.yaml

effect__experimental__Persistence.yaml

effect__experimental__RateLimiter__Redis.yaml

effect__experimental__RateLimiter.yaml

effect__experimental__Reactivity.yaml

effect__experimental__RequestResolver.yaml

effect__experimental__Sse.yaml

effect__experimental__VariantSchema.yaml

effect__experimental.yaml

effect__FastCheck.yaml

effect__Fiber.yaml

effect__FiberHandle.yaml

effect__FiberId.yaml

effect__FiberMap.yaml

effect__FiberRef.yaml

effect__FiberRefs.yaml

effect__FiberRefsPatch.yaml

effect__FiberSet.yaml

effect__FiberStatus.yaml

effect__Function.yaml

effect__GlobalValue.yaml

effect__Inspectable.yaml

effect__Iterable.yaml

effect__JSONSchema.yaml

effect__KeyedPool.yaml

effect__Layer.yaml

effect__LayerMap.yaml

effect__List.yaml

effect__Logger.yaml

effect__LogLevel.yaml

effect__LogSpan.yaml

effect__Mailbox.yaml

effect__ManagedRuntime.yaml

effect__Match.yaml

effect__MergeDecision.yaml

effect__MergeState.yaml

effect__MergeStrategy.yaml

effect__Metric.yaml

effect__MetricBoundaries.yaml

effect__MetricHook.yaml

effect__MetricKey.yaml

effect__MetricKeyType.yaml

effect__MetricLabel.yaml

effect__MetricPair.yaml

effect__MetricPolling.yaml

effect__MetricRegistry.yaml

effect__MetricState.yaml

effect__Micro.yaml

effect__ModuleVersion.yaml

effect__MutableHashMap.yaml

effect__MutableHashSet.yaml

effect__MutableList.yaml

effect__MutableQueue.yaml

effect__MutableRef.yaml

effect__Number.yaml

effect__opentelemetry__index.yaml

effect__opentelemetry__Logger.yaml

effect__opentelemetry__Metrics.yaml

effect__opentelemetry__NodeSdk.yaml

effect__opentelemetry__Otlp.yaml

effect__opentelemetry__OtlpLogger.yaml

effect__opentelemetry__OtlpMetrics.yaml

effect__opentelemetry__OtlpResource.yaml

effect__opentelemetry__OtlpTracer.yaml

effect__opentelemetry__Resource.yaml

effect__opentelemetry__Tracer.yaml

effect__opentelemetry__WebSdk.yaml

effect__Option.yaml

effect__Order.yaml

effect__Ordering.yaml

effect__ParseResult.yaml

effect__PartitionedSemaphore.yaml

effect__Pipeable.yaml

effect__platform__ChannelSchema.yaml

effect__platform__Command.yaml

effect__platform__CommandExecutor.yaml

effect__platform__Cookies.yaml

effect__platform__Effectify.yaml

effect__platform__Error.yaml

effect__platform__Etag.yaml

effect__platform__FetchHttpClient.yaml

effect__platform__FileSystem.yaml

effect__platform__Headers.yaml

effect__platform__HttpApi.yaml

effect__platform__HttpApiBuilder.yaml

effect__platform__HttpApiClient.yaml

effect__platform__HttpApiEndpoint.yaml

effect__platform__HttpApiError.yaml

effect__platform__HttpApiGroup.yaml

effect__platform__HttpApiMiddleware.yaml

effect__platform__HttpApiScalar.yaml

effect__platform__HttpApiSchema.yaml

effect__platform__HttpApiSecurity.yaml

effect__platform__HttpApiSwagger.yaml

effect__platform__HttpApp.yaml

effect__platform__HttpBody.yaml

effect__platform__HttpClient.yaml

effect__platform__HttpClientError.yaml

effect__platform__HttpClientRequest.yaml

effect__platform__HttpClientResponse.yaml

effect__platform__HttpIncomingMessage.yaml

effect__platform__HttpLayerRouter.yaml

effect__platform__HttpMethod.yaml

effect__platform__HttpMiddleware.yaml

effect__platform__HttpMultiplex.yaml

effect__platform__HttpPlatform.yaml

effect__platform__HttpRouter.yaml

effect__platform__HttpServer.yaml

effect__platform__HttpServerError.yaml

effect__platform__HttpServerRequest.yaml

effect__platform__HttpServerRespondable.yaml

effect__platform__HttpServerResponse.yaml

effect__platform__index.yaml

effect__platform__KeyValueStore.yaml

effect__platform__MsgPack.yaml

effect__platform__Multipart.yaml

effect__platform__Ndjson.yaml

effect__platform__OpenApi.yaml

effect__platform__OpenApiJsonSchema.yaml

effect__platform__Path.yaml

effect__platform__PlatformConfigProvider.yaml

effect__platform__PlatformLogger.yaml

effect__platform__Runtime.yaml

effect__platform__Socket.yaml

effect__platform__SocketServer.yaml

effect__platform__Template.yaml

effect__platform__Terminal.yaml

effect__platform__Transferable.yaml

effect__platform__Url.yaml

effect__platform__UrlParams.yaml

effect__platform__Worker.yaml

effect__platform__WorkerError.yaml

effect__platform__WorkerRunner.yaml

effect__platform-browser__BrowserHttpClient.yaml

effect__platform-browser__BrowserWorker.yaml

effect__platform-browser__BrowserWorkerRunner.yaml

effect__platform-browser__Clipboard.yaml

effect__platform-browser__Geolocation.yaml

effect__platform-browser__index.yaml

effect__platform-browser__Permissions.yaml

effect__platform-bun__BunCommandExecutor.yaml

effect__platform-bun__BunContext.yaml

effect__platform-bun__BunFileSystem__ParcelWatcher.yaml

effect__platform-bun__BunHttpPlatform.yaml

effect__platform-bun__BunHttpServer.yaml

effect__platform-bun__BunHttpServerRequest.yaml

effect__platform-bun__BunKeyValueStore.yaml

effect__platform-bun__BunSink.yaml

effect__platform-bun__BunSocket.yaml

effect__platform-bun__BunSocketServer.yaml

effect__platform-bun__BunStream.yaml

effect__platform-bun__BunTerminal.yaml

effect__platform-bun__BunWorker.yaml

effect__platform-bun__index.yaml

effect__platform-node__index.yaml

effect__platform-node__NodeCommandExecutor.yaml

effect__platform-node__NodeContext.yaml

effect__platform-node__NodeFileSystem__ParcelWatcher.yaml

effect__platform-node__NodeHttpClient.yaml

effect__platform-node__NodeHttpServer.yaml

effect__platform-node__NodeKeyValueStore.yaml

effect__platform-node__NodeTerminal.yaml

effect__platform-node__NodeWorker.yaml

effect__platform-node__Undici.yaml

effect__platform-node-shared__NodeCommandExecutor.yaml

effect__platform-node-shared__NodeFileSystem__ParcelWatcher.yaml

effect__platform-node-shared__NodeKeyValueStore.yaml

effect__platform-node-shared__NodeMultipart.yaml

effect__platform-node-shared__NodeSink.yaml

effect__platform-node-shared__NodeSocket.yaml

effect__platform-node-shared__NodeStream.yaml

effect__platform-node-shared__NodeTerminal.yaml

effect__platform.yaml

effect__Pool.yaml

effect__Predicate.yaml

effect__Pretty.yaml

effect__printer__Doc.yaml

effect__printer__DocStream.yaml

effect__printer__DocTree.yaml

effect__printer__Flatten.yaml

effect__printer__index.yaml

effect__printer__Layout.yaml

effect__printer__Optimize.yaml

effect__printer__PageWidth.yaml

effect__printer-ansi__Ansi.yaml

effect__printer-ansi__AnsiDoc.yaml

effect__printer-ansi__Color.yaml

effect__printer-ansi__index.yaml

effect__printer-ansi.yaml

effect__RateLimiter.yaml

effect__RcMap.yaml

effect__RcRef.yaml

effect__Readable.yaml

effect__Record.yaml

effect__Redacted.yaml

effect__RedBlackTree.yaml

effect__Ref.yaml

effect__Reloadable.yaml

effect__Request.yaml

effect__RequestBlock.yaml

effect__RequestResolver.yaml

effect__Resource.yaml

effect__rpc__index.yaml

effect__rpc__Rpc.yaml

effect__rpc__RpcClient.yaml

effect__rpc__RpcClientError.yaml

effect__rpc__RpcGroup.yaml

effect__rpc__RpcMessage.yaml

effect__rpc__RpcMiddleware.yaml

effect__rpc__RpcSchema.yaml

effect__rpc__RpcSerialization.yaml

effect__rpc__RpcServer.yaml

effect__rpc__RpcTest.yaml

effect__rpc.yaml

effect__Runtime.yaml

effect__RuntimeFlags.yaml

effect__RuntimeFlagsPatch.yaml

effect__Schedule.yaml

effect__ScheduleDecision.yaml

effect__ScheduleInterval.yaml

effect__ScheduleIntervals.yaml

effect__Scheduler.yaml

effect__Schema.yaml

effect__SchemaAST.yaml

effect__Scope.yaml

effect__ScopedCache.yaml

effect__ScopedRef.yaml

effect__Secret.yaml

effect__SingleProducerAsyncInput.yaml

effect__Sink.yaml

effect__SortedMap.yaml

effect__SortedSet.yaml

effect__sql__index.yaml

effect__sql__Migrator__FileSystem.yaml

effect__sql__Migrator.yaml

effect__sql__Model.yaml

effect__sql__SqlClient.yaml

effect__sql__SqlConnection.yaml

effect__sql__SqlError.yaml

effect__sql__SqlEventJournal.yaml

effect__sql__SqlEventLogServer.yaml

effect__sql__SqlPersistedQueue.yaml

effect__sql__SqlResolver.yaml

effect__sql__SqlSchema.yaml

effect__sql__Statement.yaml

effect__sql-clickhouse__ClickhouseClient.yaml

effect__sql-clickhouse__ClickhouseMigrator.yaml

effect__sql-clickhouse__index.yaml

effect__sql-d1__D1Client.yaml

effect__sql-d1__index.yaml

effect__sql-drizzle__Mysql.yaml

effect__sql-drizzle__Pg.yaml

effect__sql-drizzle__Sqlite.yaml

effect__sql-kysely__Kysely.yaml

effect__sql-kysely__Mssql.yaml

effect__sql-kysely__Mysql.yaml

effect__sql-kysely__patch.types.yaml

effect__sql-kysely__Pg.yaml

effect__sql-kysely__Sqlite.yaml

effect__sql-libsql__index.yaml

effect__sql-mssql__index.yaml

effect__sql-mssql__MssqlClient.yaml

effect__sql-mssql__Parameter.yaml

effect__sql-mssql__Procedure.yaml

effect__sql-mysql2__index.yaml

effect__sql-mysql2__MysqlClient.yaml

effect__sql-pg__index.yaml

effect__sql-pg__PgClient.yaml

effect__sql-sqlite-bun__index.yaml

effect__sql-sqlite-bun__SqliteClient.yaml

effect__sql-sqlite-do__index.yaml

effect__sql-sqlite-do__SqliteClient.yaml

effect__sql-sqlite-node__index.yaml

effect__sql-sqlite-node__SqliteClient.yaml

effect__sql-sqlite-react-native__index.yaml

effect__sql-sqlite-react-native__SqliteClient.yaml

effect__sql-sqlite-wasm__index.yaml

effect__sql-sqlite-wasm__SqliteClient.yaml

effect__sql.yaml

effect__STM.yaml

effect__Stream.yaml

effect__Streamable.yaml

effect__StreamEmit.yaml

effect__StreamHaltStrategy.yaml

effect__Struct.yaml

effect__Subscribable.yaml

effect__SubscriptionRef.yaml

effect__Supervisor.yaml

effect__Symbol.yaml

effect__SynchronizedRef.yaml

effect__Take.yaml

effect__TArray.yaml

effect__TDeferred.yaml

effect__TestAnnotation.yaml

effect__TestAnnotationMap.yaml

effect__TestAnnotations.yaml

effect__TestClock.yaml

effect__TestConfig.yaml

effect__TestContext.yaml

effect__TestLive.yaml

effect__TestServices.yaml

effect__TestSized.yaml

effect__TMap.yaml

effect__TPriorityQueue.yaml

effect__TReentrantLock.yaml

effect__TRef.yaml

effect__Trie.yaml

effect__TSemaphore.yaml

effect__TSet.yaml

effect__TSubscriptionRef.yaml

effect__Tuple.yaml

effect__typeclass__Alternative.yaml

effect__typeclass__Applicative.yaml

effect__typeclass__Bicovariant.yaml

effect__typeclass__Bounded.yaml

effect__typeclass__Chainable.yaml

effect__typeclass__Contravariant.yaml

effect__typeclass__Coproduct.yaml

effect__typeclass__Covariant.yaml

effect__typeclass__data__Array.yaml

effect__typeclass__data__BigInt.yaml

effect__typeclass__data__Boolean.yaml

effect__typeclass__data__Duration.yaml

effect__typeclass__data__Effect.yaml

effect__typeclass__data__Either.yaml

effect__typeclass__data__Identity.yaml

effect__typeclass__data__Micro.yaml

effect__typeclass__data__Number.yaml

effect__typeclass__data__Option.yaml

effect__typeclass__data__Ordering.yaml

effect__typeclass__data__Predicate.yaml

effect__typeclass__data__Record.yaml

effect__typeclass__data__String.yaml

effect__typeclass__data__Tuple.yaml

effect__typeclass__Filterable.yaml

effect__typeclass__FlatMap.yaml

effect__typeclass__Foldable.yaml

effect__typeclass__index.yaml

effect__typeclass__Invariant.yaml

effect__typeclass__Monad.yaml

effect__typeclass__Monoid.yaml

effect__typeclass__Of.yaml

effect__typeclass__Pointed.yaml

effect__typeclass__Product.yaml

effect__typeclass__SemiAlternative.yaml

effect__typeclass__SemiApplicative.yaml

effect__typeclass__SemiCoproduct.yaml

effect__typeclass__Semigroup.yaml

effect__typeclass__SemiProduct.yaml

effect__typeclass__Traversable.yaml

effect__typeclass__TraversableFilterable.yaml

effect__typeclass.yaml

effect__Types.yaml

effect__UpstreamPullRequest.yaml

effect__UpstreamPullStrategy.yaml

effect__Utils.yaml

effect__vitest__index.yaml

effect__vitest__utils.yaml

effect__workflow__Activity.yaml

effect__workflow__DurableClock.yaml

effect__workflow__DurableDeferred.yaml

effect__workflow__DurableQueue.yaml

effect__workflow__DurableRateLimiter.yaml

effect__workflow__Workflow.yaml

effect__workflow__WorkflowEngine.yaml

effect__workflow__WorkflowProxy.yaml

effect__workflow__WorkflowProxyServer.yaml

effect__workflow.yaml

README.md

Migration annotations

Add one YAML file per v3 module. Each file maps stable API ids (without the snapshot's trailing #type or #value facet) to migration guidance:

effect/Effect#async:
  replacement: Effect.callback
  note: Use the callback constructor.
  example: Effect.callback((resume) => resume(Effect.void))

Run pnpm api-diff --check to list missing ids and pnpm api-diff --write-doc migration/v3-to-v4.md to regenerate the reference.

.repos/effect/migration/annotations

README.md

Migration annotations#

Migration annotations