effect 4.0.0-beta.67 → 4.0.0-beta.69

package/src/LayerMap.ts

@@ -58,7 +58,7 @@ type IdleTimeToLiveInput<K> = Duration.Input | ((key: K) => Duration.Input)
  * **Example** (Managing keyed layers)
  *
  * ```ts
- * import { Effect, Layer, LayerMap, Context } from "effect"
+ * import { Context, Effect, Layer, LayerMap } from "effect"
  *
  * // Define a service key
  * const DatabaseService = Context.Service<{
@@ -87,7 +87,7 @@ type IdleTimeToLiveInput<K> = Duration.Input | ((key: K) => Duration.Input)
  * })
  * ```
  *
- * @category Models
+ * @category models
  * @since 3.14.0
  */
 export interface LayerMap<in out K, in out I, in out E = never> {
@@ -121,7 +121,7 @@ export interface LayerMap<in out K, in out I, in out E = never> {
  * **Example** (Creating a layer map)
  *
  * ```ts
- * import { Effect, Layer, LayerMap, Context } from "effect"
+ * import { Context, Effect, Layer, LayerMap } from "effect"
  *
  * // Define a service key
  * const DatabaseService = Context.Service<{
@@ -154,7 +154,7 @@ export interface LayerMap<in out K, in out I, in out E = never> {
  * })
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 3.14.0
  */
 export const make: <
@@ -208,7 +208,7 @@ export const make: <
  * **Example** (Creating a layer map from a record)
  *
  * ```ts
- * import { Effect, Layer, LayerMap, Context } from "effect"
+ * import { Context, Effect, Layer, LayerMap } from "effect"
  *
  * // Define service keys
  * const DevDatabase = Context.Service<{
@@ -243,7 +243,7 @@ export const make: <
  * })
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 3.14.0
  */
 export const fromRecord = <
@@ -277,7 +277,7 @@ export const fromRecord = <
  * It combines a `Context.Service` tag for the `LayerMap` with default layers
  * and helper accessors for retrieving, using, and invalidating keyed resources.
  *
- * @category Service
+ * @category services
  * @since 3.14.0
  */
 export interface TagClass<
@@ -328,7 +328,7 @@ export interface TagClass<
  * **Example** (Defining a layer map service)
  *
  * ```ts
- * import { Console, Effect, Layer, LayerMap, Context } from "effect"
+ * import { Console, Context, Effect, Layer, LayerMap } from "effect"
  *
  * // Define a service key
  * const Greeter = Context.Service<{
@@ -361,7 +361,7 @@ export interface TagClass<
  * )
  * ```
  *
- * @category Service
+ * @category services
  * @since 3.14.0
  */
 export const Service = <Self>() =>
@@ -435,14 +435,13 @@ export const Service = <Self>() =>
 /**
  * Type helpers for values created with `LayerMap.Service`.
  *
- * @category Service
  * @since 3.14.0
  */
 export declare namespace Service {
   /**
    * Extracts the key type accepted by a `LayerMap.Service` definition.
    *
-   * @category Service
+   * @category services
    * @since 3.14.0
    */
   export type Key<Options> = Options extends { readonly lookup: (key: infer K) => any } ? K
@@ -452,7 +451,7 @@ export declare namespace Service {
   /**
    * Extracts the layer type produced by a `LayerMap.Service` definition.
    *
-   * @category Service
+   * @category services
    * @since 3.14.0
    */
   export type Layers<Options> = Options extends { readonly lookup: (key: infer _K) => infer Layers } ? Layers
@@ -463,7 +462,7 @@ export declare namespace Service {
    * Extracts the services provided by the layers in a `LayerMap.Service`
    * definition.
    *
-   * @category Service
+   * @category services
    * @since 3.14.0
    */
   export type Success<Options> = Layers<Options> extends Layer.Layer<infer _A, infer _E, infer _R> ? _A : never
@@ -471,7 +470,7 @@ export declare namespace Service {
   /**
    * Extracts the error type of the layers in a `LayerMap.Service` definition.
    *
-   * @category Service
+   * @category services
    * @since 3.14.0
    */
   export type Error<Options> = Layers<Options> extends Layer.Layer<infer _A, infer _E, infer _R> ? _E : never
@@ -480,8 +479,8 @@ export declare namespace Service {
    * Extracts the service requirements of the layers in a `LayerMap.Service`
    * definition.
    *
-   * @category Service
-   * @since 3.14.0
+   * @category services
+   * @since 4.0.0
    */
   export type Services<Options> = Layers<Options> extends Layer.Layer<infer _A, infer _E, infer _R> ? _R : never
 }

package/src/LogLevel.ts

@@ -78,7 +78,7 @@ import * as References from "./References.ts"
  * ```
  *
  * @category models
- * @since 4.0.0
+ * @since 2.0.0
  */
 export type LogLevel = "All" | "Fatal" | "Error" | "Warn" | "Info" | "Debug" | "Trace" | "None"
 
@@ -177,7 +177,7 @@ export const getOrdinal = (self: LogLevel): number => effect.logLevelToOrder(sel
  * ```
  *
  * @category ordering
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isGreaterThan: {
   /**
@@ -210,7 +210,7 @@ export const isGreaterThan: {
    * ```
    *
    * @category ordering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   (that: LogLevel): (self: LogLevel) => boolean
   /**
@@ -243,7 +243,7 @@ export const isGreaterThan: {
    * ```
    *
    * @category ordering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   (self: LogLevel, that: LogLevel): boolean
 } = effect.isLogLevelGreaterThan
@@ -286,7 +286,7 @@ export const isGreaterThan: {
  * ```
  *
  * @category ordering
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isGreaterThanOrEqualTo: {
   /**
@@ -327,7 +327,7 @@ export const isGreaterThanOrEqualTo: {
    * ```
    *
    * @category ordering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   (that: LogLevel): (self: LogLevel) => boolean
   /**
@@ -368,7 +368,7 @@ export const isGreaterThanOrEqualTo: {
    * ```
    *
    * @category ordering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   (self: LogLevel, that: LogLevel): boolean
 } = Ord.isGreaterThanOrEqualTo(Order)
@@ -403,7 +403,7 @@ export const isGreaterThanOrEqualTo: {
  * ```
  *
  * @category ordering
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isLessThan: {
   /**
@@ -436,7 +436,7 @@ export const isLessThan: {
    * ```
    *
    * @category ordering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   (that: LogLevel): (self: LogLevel) => boolean
   /**
@@ -469,7 +469,7 @@ export const isLessThan: {
    * ```
    *
    * @category ordering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   (self: LogLevel, that: LogLevel): boolean
 } = Ord.isLessThan(Order)
@@ -510,7 +510,7 @@ export const isLessThan: {
  * ```
  *
  * @category ordering
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isLessThanOrEqualTo: {
   /**
@@ -549,7 +549,7 @@ export const isLessThanOrEqualTo: {
    * ```
    *
    * @category ordering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   (that: LogLevel): (self: LogLevel) => boolean
   /**
@@ -588,7 +588,7 @@ export const isLessThanOrEqualTo: {
    * ```
    *
    * @category ordering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   (self: LogLevel, that: LogLevel): boolean
 } = Ord.isLessThanOrEqualTo(Order)

package/src/Logger.ts

@@ -198,7 +198,7 @@ export interface Options<out Message> {
  * ```
  *
  * @category guards
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isLogger = (u: unknown): u is Logger<unknown, unknown> => Predicate.hasProperty(u, TypeId)
 
@@ -460,7 +460,7 @@ export const withConsoleError = <Message, Output>(
  * ```
  *
  * @category utils
- * @since 2.0.0
+ * @since 3.8.0
  */
 export const withLeveledConsole = <Message, Output>(
   self: Logger<Message, Output>
@@ -552,8 +552,7 @@ const format = (
  * **Example** (Creating loggers from functions)
  *
  * ```ts
- * import { Effect, Logger } from "effect"
- * import { CurrentLogAnnotations } from "effect/References"
+ * import { Effect, Logger, References } from "effect"
  *
  * // Simple text logger
  * const textLogger = Logger.make((options) =>
@@ -566,7 +565,7 @@ const format = (
  *   level: options.logLevel,
  *   message: options.message,
  *   fiberId: options.fiber.id,
- *   annotations: options.fiber.getRef(CurrentLogAnnotations)
+ *   annotations: options.fiber.getRef(References.CurrentLogAnnotations)
  * }))
  *
  * // Custom filtering logger
@@ -616,7 +615,7 @@ export const make: <Message, Output>(
  * ```
  *
  * @category constructors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const defaultLogger: Logger<unknown, void> = effect.defaultLogger
 
@@ -874,7 +873,7 @@ export const formatJson = map(formatStructured, Formatter.formatJson)
  * ```
  *
  * @category constructors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const batched = dual<
   /**
@@ -927,7 +926,7 @@ export const batched = dual<
    * ```
    *
    * @category constructors
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <Output>(
     options: {
@@ -987,7 +986,7 @@ export const batched = dual<
    * ```
    *
    * @category constructors
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <Message, Output>(
     self: Logger<Message, Output>,
@@ -1129,7 +1128,7 @@ export const consolePretty: (
  * ```
  *
  * @category constructors
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const consoleLogFmt: Logger<unknown, void> = withConsoleLog(formatLogFmt)
 
@@ -1301,7 +1300,7 @@ export const consoleJson: Logger<unknown, void> = withConsoleLog(formatJson)
  * ```
  *
  * @category constructors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const tracerLogger: Logger<unknown, void> = effect.tracerLogger
 
@@ -1382,8 +1381,8 @@ export const layer = <
  * **Example** (Writing JSON logs to a file)
  *
  * ```ts
- * import { NodeFileSystem, NodeRuntime } from "@effect/platform-node"
  * import { Effect, Layer, Logger } from "effect"
+ * import { NodeFileSystem, NodeRuntime } from "@effect/platform-node"
  *
  * const fileLogger = Logger.formatJson.pipe(
  *   Logger.toFile("/tmp/log.txt")
@@ -1403,8 +1402,8 @@ export const layer = <
  * **Example** (Writing logs to files)
  *
  * ```ts
- * import { NodeFileSystem } from "@effect/platform-node"
  * import { Duration, Effect, Logger } from "effect"
+ * import { NodeFileSystem } from "@effect/platform-node"
  *
  * // Basic file logging. The scope keeps the file open while logs are emitted
  * // and flushes pending entries when it closes.
@@ -1480,8 +1479,8 @@ export const toFile = dual<
    * **Example** (Writing JSON logs to a file)
    *
    * ```ts
-   * import { NodeFileSystem, NodeRuntime } from "@effect/platform-node"
    * import { Effect, Layer, Logger } from "effect"
+   * import { NodeFileSystem, NodeRuntime } from "@effect/platform-node"
    *
    * const fileLogger = Logger.formatJson.pipe(
    *   Logger.toFile("/tmp/log.txt")
@@ -1501,8 +1500,8 @@ export const toFile = dual<
    * **Example** (Writing logs to files)
    *
    * ```ts
-   * import { NodeFileSystem } from "@effect/platform-node"
    * import { Duration, Effect, Logger } from "effect"
+   * import { NodeFileSystem } from "@effect/platform-node"
    *
    * // Basic file logging. The scope keeps the file open while logs are emitted
    * // and flushes pending entries when it closes.
@@ -1587,8 +1586,8 @@ export const toFile = dual<
    * **Example** (Writing JSON logs to a file)
    *
    * ```ts
-   * import { NodeFileSystem, NodeRuntime } from "@effect/platform-node"
    * import { Effect, Layer, Logger } from "effect"
+   * import { NodeFileSystem, NodeRuntime } from "@effect/platform-node"
    *
    * const fileLogger = Logger.formatJson.pipe(
    *   Logger.toFile("/tmp/log.txt")
@@ -1608,8 +1607,8 @@ export const toFile = dual<
    * **Example** (Writing logs to files)
    *
    * ```ts
-   * import { NodeFileSystem } from "@effect/platform-node"
    * import { Duration, Effect, Logger } from "effect"
+   * import { NodeFileSystem } from "@effect/platform-node"
    *
    * // Basic file logging. The scope keeps the file open while logs are emitted
    * // and flushes pending entries when it closes.

package/src/ManagedRuntime.ts

@@ -69,7 +69,7 @@ export declare namespace ManagedRuntime {
    * Extracts the services available from a `ManagedRuntime`.
    *
    * @category type-level
-   * @since 4.0.0
+   * @since 3.4.0
    */
   export type Services<T extends ManagedRuntime<never, any>> = [T] extends [ManagedRuntime<infer R, infer _E>] ? R
     : never
@@ -187,12 +187,10 @@ export interface ManagedRuntime<in R, out ER> {
  * subsequent runs. Resources acquired by the layer are owned by the runtime and
  * are released when `dispose` or `disposeEffect` is run.
  *
- * @category runtime class
- * @since 2.0.0
  * **Example** (Creating a managed runtime)
  *
  * ```ts
- * import { Effect, Layer, ManagedRuntime, Context } from "effect"
+ * import { Context, Effect, Layer, ManagedRuntime } from "effect"
  *
  * class Notifications extends Context.Service<Notifications, {
  *   readonly notify: (message: string) => Effect.Effect<void>
@@ -214,6 +212,9 @@ export interface ManagedRuntime<in R, out ER> {
  * runtime.runPromise(program)
  * // Hello, world!
  * ```
+ *
+ * @category runtime class
+ * @since 2.0.0
  */
 export const make = <R, ER>(
   layer: Layer.Layer<R, ER, never>,

package/src/Match.ts

@@ -65,7 +65,7 @@ const TypeId = internal.TypeId
  * // Output: "string: some input"
  * ```
  *
- * @category Model
+ * @category models
  * @since 4.0.0
  */
 export type Matcher<Input, Filters, RemainingApplied, Result, Provided, Return = any> =
@@ -1067,8 +1067,7 @@ export const tag: <
  * **Example** (Matching tag prefixes)
  *
  * ```ts
- * import { pipe } from "effect"
- * import { Match } from "effect"
+ * import { Match, pipe } from "effect"
  *
  * const match = pipe(
  *   Match.type<{ _tag: "A" } | { _tag: "B" } | { _tag: "A.A" } | {}>(),
@@ -1994,7 +1993,6 @@ type Fail = typeof Fail
  * application. These types enable the sophisticated type inference that makes
  * pattern matching both type-safe and ergonomic.
  *
- * @category types
  * @since 4.0.0
  */
 export declare namespace Types {