effect 4.0.0-beta.67 → 4.0.0-beta.68

package/src/Context.ts

@@ -51,7 +51,7 @@ export const ServiceTypeId: ServiceTypeId = "~effect/Context/Service"
  * so yielding it inside `Effect.gen` retrieves the service from the current
  * fiber context.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Key<out Identifier, out Shape> extends Effect<Shape, never, Identifier> {
@@ -85,7 +85,7 @@ export interface Key<out Identifier, out Shape> extends Effect<Shape, never, Ide
  * const context = Context.make(Database, { query: (sql) => `Result: ${sql}` })
  * ```
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Service<in out Identifier, in out Shape> extends Key<Identifier, Shape> {
@@ -103,7 +103,7 @@ export interface Service<in out Identifier, in out Shape> extends Key<Identifier
  * Use this shape when declaring services as classes. The class itself is the
  * Context key, and its string `key` identifies the service at runtime.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface ServiceClass<in out Self, in out Identifier extends string, in out Shape>
@@ -124,7 +124,7 @@ export declare namespace ServiceClass {
    * Runtime and type-level metadata carried by a class-style service key,
    * including its service type identifier, string key, and service shape.
    *
-   * @category Models
+   * @category models
    * @since 4.0.0
    */
   export interface Shape<Identifier extends string, Service> {
@@ -166,7 +166,7 @@ export declare namespace ServiceClass {
  * const config = Context.make(Config, { port: 8080 })
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const Service: {
@@ -202,7 +202,7 @@ export const Service: {
    * const config = Context.make(Config, { port: 8080 })
    * ```
    *
-   * @category Constructors
+   * @category constructors
    * @since 4.0.0
    */
   <Identifier, Shape = Identifier>(key: string): Service<Identifier, Shape>
@@ -238,7 +238,7 @@ export const Service: {
    * const config = Context.make(Config, { port: 8080 })
    * ```
    *
-   * @category Constructors
+   * @category constructors
    * @since 4.0.0
    */
   <Self, Shape>(): <
@@ -287,7 +287,7 @@ export const Service: {
    * const config = Context.make(Config, { port: 8080 })
    * ```
    *
-   * @category Constructors
+   * @category constructors
    * @since 4.0.0
    */
   <Self>(): <
@@ -400,8 +400,8 @@ const ReferenceTypeId = "~effect/Context/Reference" as const
  * const logger = Context.get(context, LoggerRef) // Uses default value
  * ```
  *
- * @category Models
- * @since 4.0.0
+ * @category models
+ * @since 3.11.0
  */
 export interface Reference<in out Shape> extends Service<never, Shape> {
   readonly [ReferenceTypeId]: typeof ReferenceTypeId
@@ -429,7 +429,7 @@ export interface Reference<in out Shape> extends Service<never, Shape> {
  * type DatabaseId = Context.Service.Identifier<typeof Database>
  * ```
  *
- * @since 4.0.0
+ * @since 2.0.0
  */
 export declare namespace Service {
   /**
@@ -448,7 +448,7 @@ export declare namespace Service {
    * ]
    * ```
    *
-   * @category Models
+   * @category models
    * @since 4.0.0
    */
   export type Any = Key<never, any> | Key<any, any>
@@ -471,7 +471,7 @@ export declare namespace Service {
    * // DatabaseService is { query: (sql: string) => string }
    * ```
    *
-   * @category Models
+   * @category models
    * @since 4.0.0
    */
   export type Shape<T> = T extends Key<infer _I, infer S> ? S : never
@@ -494,8 +494,8 @@ export declare namespace Service {
    * // DatabaseId is the identifier type
    * ```
    *
-   * @category Models
-   * @since 4.0.0
+   * @category models
+   * @since 2.0.0
    */
   export type Identifier<T> = T extends Key<infer I, infer _S> ? I : never
 }
@@ -528,8 +528,8 @@ const TypeId = "~effect/Context" as const
  *   .pipe(Context.add(Database, { query: (sql) => `Result: ${sql}` }))
  * ```
  *
- * @category Models
- * @since 4.0.0
+ * @category models
+ * @since 2.0.0
  */
 export interface Context<in Services> extends Equal.Equal, Pipeable, Inspectable {
   readonly [TypeId]: {
@@ -562,7 +562,7 @@ export interface Context<in Services> extends Equal.Equal, Pipeable, Inspectable
  * const context = Context.makeUnsafe(map)
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const makeUnsafe = <Services = never>(mapUnsafe: ReadonlyMap<string, any>): Context<Services> => {
@@ -615,8 +615,8 @@ const Proto: Omit<Context<never>, "mapUnsafe" | "mutable"> = {
  * assert.strictEqual(Context.isContext(Context.empty()), true)
  * ```
  *
- * @category Guards
- * @since 4.0.0
+ * @category guards
+ * @since 2.0.0
  */
 export const isContext = (u: unknown): u is Context<never> => hasProperty(u, TypeId)
 
@@ -632,7 +632,7 @@ export const isContext = (u: unknown): u is Context<never> => hasProperty(u, Typ
  * assert.strictEqual(Context.isKey(Context.Service("Service")), true)
  * ```
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isKey = (u: unknown): u is Key<any, any> => hasProperty(u, ServiceTypeId)
@@ -654,8 +654,8 @@ export const isKey = (u: unknown): u is Key<any, any> => hasProperty(u, ServiceT
  * assert.strictEqual(Context.isReference(Context.Service("Key")), false)
  * ```
  *
- * @category Guards
- * @since 4.0.0
+ * @category guards
+ * @since 3.11.0
  */
 export const isReference = (u: unknown): u is Reference<any> => hasProperty(u, ReferenceTypeId)
 
@@ -671,8 +671,8 @@ export const isReference = (u: unknown): u is Reference<any> => hasProperty(u, R
  * assert.strictEqual(Context.isContext(Context.empty()), true)
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export const empty = (): Context<never> => emptyContext
 const emptyContext = makeUnsafe(new Map())
@@ -693,8 +693,8 @@ const emptyContext = makeUnsafe(new Map())
  * assert.deepStrictEqual(Context.get(context, Port), { PORT: 8080 })
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export const make = <I, S>(
   key: Key<I, S>,
@@ -707,7 +707,7 @@ export const make = <I, S>(
  * **Example** (Adding a service to a context)
  *
  * ```ts
- * import { pipe, Context } from "effect"
+ * import { Context, pipe } from "effect"
  * import * as assert from "node:assert"
  *
  * const Port = Context.Service<{ PORT: number }>("Port")
@@ -725,7 +725,7 @@ export const make = <I, S>(
  * ```
  *
  * @category Adders
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const add: {
   /**
@@ -734,7 +734,7 @@ export const add: {
    * **Example** (Adding a service to a context)
    *
    * ```ts
-   * import { pipe, Context } from "effect"
+   * import { Context, pipe } from "effect"
    * import * as assert from "node:assert"
    *
    * const Port = Context.Service<{ PORT: number }>("Port")
@@ -752,7 +752,7 @@ export const add: {
    * ```
    *
    * @category Adders
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <I, S>(key: Key<I, S>, service: Types.NoInfer<S>): <Services>(self: Context<Services>) => Context<Services | I>
   /**
@@ -761,7 +761,7 @@ export const add: {
    * **Example** (Adding a service to a context)
    *
    * ```ts
-   * import { pipe, Context } from "effect"
+   * import { Context, pipe } from "effect"
    * import * as assert from "node:assert"
    *
    * const Port = Context.Service<{ PORT: number }>("Port")
@@ -779,7 +779,7 @@ export const add: {
    * ```
    *
    * @category Adders
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <Services, I, S>(self: Context<Services>, key: Key<I, S>, service: Types.NoInfer<S>): Context<Services | I>
 } = dual(3, <Services, I, S>(
@@ -878,8 +878,8 @@ export const addOrOmit: {
  * console.log(database.query("SELECT 1")) // "fallback"
  * ```
  *
- * @category Getters
- * @since 4.0.0
+ * @category getters
+ * @since 3.7.0
  */
 export const getOrElse: {
   /**
@@ -916,8 +916,8 @@ export const getOrElse: {
    * console.log(database.query("SELECT 1")) // "fallback"
    * ```
    *
-   * @category Getters
-   * @since 4.0.0
+   * @category getters
+   * @since 3.7.0
    */
   <S, I, B>(key: Key<I, S>, orElse: LazyArg<B>): <Services>(self: Context<Services>) => S | B
   /**
@@ -954,8 +954,8 @@ export const getOrElse: {
    * console.log(database.query("SELECT 1")) // "fallback"
    * ```
    *
-   * @category Getters
-   * @since 4.0.0
+   * @category getters
+   * @since 3.7.0
    */
   <Services, S, I, B>(self: Context<Services>, key: Key<I, S>, orElse: LazyArg<B>): S | B
 } = dual(3, <Services, S, I, B>(self: Context<Services>, key: Key<I, S>, orElse: LazyArg<B>): S | B => {
@@ -974,7 +974,7 @@ export const getOrElse: {
  * This is a raw lookup and does not resolve default values for
  * `Context.Reference` keys.
  *
- * @category Getters
+ * @category getters
  * @since 4.0.0
  */
 export const getOrUndefined: {
@@ -987,7 +987,7 @@ export const getOrUndefined: {
    * This is a raw lookup and does not resolve default values for
    * `Context.Reference` keys.
    *
-   * @category Getters
+   * @category getters
    * @since 4.0.0
    */
   <S, I>(key: Key<I, S>): <Services>(self: Context<Services>) => S | undefined
@@ -1000,7 +1000,7 @@ export const getOrUndefined: {
    * This is a raw lookup and does not resolve default values for
    * `Context.Reference` keys.
    *
-   * @category Getters
+   * @category getters
    * @since 4.0.0
    */
   <Services, S, I>(self: Context<Services>, key: Key<I, S>): S | undefined
@@ -1021,9 +1021,6 @@ export const getOrUndefined: {
  *
  * For a safer version see {@link getOption}.
  *
- * @param self - The `Context` to search for the service.
- * @param service - The `Service` of the service to retrieve.
- *
  * **Example** (Getting services unsafely)
  *
  * ```ts
@@ -1055,9 +1052,6 @@ export const getUnsafe: {
    *
    * For a safer version see {@link getOption}.
    *
-   * @param self - The `Context` to search for the service.
-   * @param service - The `Service` of the service to retrieve.
-   *
    * **Example** (Getting services unsafely)
    *
    * ```ts
@@ -1089,9 +1083,6 @@ export const getUnsafe: {
    *
    * For a safer version see {@link getOption}.
    *
-   * @param self - The `Context` to search for the service.
-   * @param service - The `Service` of the service to retrieve.
-   *
    * **Example** (Getting services unsafely)
    *
    * ```ts
@@ -1125,13 +1116,10 @@ export const getUnsafe: {
 /**
  * Get a service from the context that corresponds to the given key.
  *
- * @param self - The `Context` to search for the service.
- * @param service - The `Service` of the service to retrieve.
- *
  * **Example** (Getting a service from a context)
  *
  * ```ts
- * import { pipe, Context } from "effect"
+ * import { Context, pipe } from "effect"
  * import * as assert from "node:assert"
  *
  * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1145,20 +1133,17 @@ export const getUnsafe: {
  * assert.deepStrictEqual(Context.get(context, Timeout), { TIMEOUT: 5000 })
  * ```
  *
- * @category Getters
- * @since 4.0.0
+ * @category getters
+ * @since 2.0.0
  */
 export const get: {
   /**
    * Get a service from the context that corresponds to the given key.
    *
-   * @param self - The `Context` to search for the service.
-   * @param service - The `Service` of the service to retrieve.
-   *
    * **Example** (Getting a service from a context)
    *
    * ```ts
-   * import { pipe, Context } from "effect"
+   * import { Context, pipe } from "effect"
    * import * as assert from "node:assert"
    *
    * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1172,20 +1157,17 @@ export const get: {
    * assert.deepStrictEqual(Context.get(context, Timeout), { TIMEOUT: 5000 })
    * ```
    *
-   * @category Getters
-   * @since 4.0.0
+   * @category getters
+   * @since 2.0.0
    */
   <Services, I extends Services, S>(service: Key<I, S>): (self: Context<Services>) => S
   /**
    * Get a service from the context that corresponds to the given key.
    *
-   * @param self - The `Context` to search for the service.
-   * @param service - The `Service` of the service to retrieve.
-   *
    * **Example** (Getting a service from a context)
    *
    * ```ts
-   * import { pipe, Context } from "effect"
+   * import { Context, pipe } from "effect"
    * import * as assert from "node:assert"
    *
    * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1199,8 +1181,8 @@ export const get: {
    * assert.deepStrictEqual(Context.get(context, Timeout), { TIMEOUT: 5000 })
    * ```
    *
-   * @category Getters
-   * @since 4.0.0
+   * @category getters
+   * @since 2.0.0
    */
   <Services, I extends Services, S>(self: Context<Services>, service: Key<I, S>): S
 } = getUnsafe
@@ -1273,13 +1255,10 @@ const serviceNotFoundError = (service: Key<any, any>) => {
  * is a `Context.Reference` and no override is stored, returns `Option.some` of
  * the cached default value. Missing non-reference keys return `Option.none`.
  *
- * @param self - The `Context` to search for the service.
- * @param service - The `Service` of the service to retrieve.
- *
  * **Example** (Getting optional services)
  *
  * ```ts
- * import { Option, Context } from "effect"
+ * import { Context, Option } from "effect"
  * import * as assert from "node:assert"
  *
  * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1294,8 +1273,8 @@ const serviceNotFoundError = (service: Key<any, any>) => {
  * assert.deepStrictEqual(Context.getOption(context, Timeout), Option.none())
  * ```
  *
- * @category Getters
- * @since 4.0.0
+ * @category getters
+ * @since 2.0.0
  */
 export const getOption: {
   /**
@@ -1307,13 +1286,10 @@ export const getOption: {
    * is a `Context.Reference` and no override is stored, returns `Option.some` of
    * the cached default value. Missing non-reference keys return `Option.none`.
    *
-   * @param self - The `Context` to search for the service.
-   * @param service - The `Service` of the service to retrieve.
-   *
    * **Example** (Getting optional services)
    *
    * ```ts
-   * import { Option, Context } from "effect"
+   * import { Context, Option } from "effect"
    * import * as assert from "node:assert"
    *
    * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1328,8 +1304,8 @@ export const getOption: {
    * assert.deepStrictEqual(Context.getOption(context, Timeout), Option.none())
    * ```
    *
-   * @category Getters
-   * @since 4.0.0
+   * @category getters
+   * @since 2.0.0
    */
   <S, I>(service: Key<I, S>): <Services>(self: Context<Services>) => Option.Option<S>
   /**
@@ -1341,13 +1317,10 @@ export const getOption: {
    * is a `Context.Reference` and no override is stored, returns `Option.some` of
    * the cached default value. Missing non-reference keys return `Option.none`.
    *
-   * @param self - The `Context` to search for the service.
-   * @param service - The `Service` of the service to retrieve.
-   *
    * **Example** (Getting optional services)
    *
    * ```ts
-   * import { Option, Context } from "effect"
+   * import { Context, Option } from "effect"
    * import * as assert from "node:assert"
    *
    * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1362,8 +1335,8 @@ export const getOption: {
    * assert.deepStrictEqual(Context.getOption(context, Timeout), Option.none())
    * ```
    *
-   * @category Getters
-   * @since 4.0.0
+   * @category getters
+   * @since 2.0.0
    */
   <Services, S, I>(self: Context<Services>, service: Key<I, S>): Option.Option<S>
 } = dual(2, <Services, I extends Services, S>(self: Context<Services>, service: Key<I, S>): Option.Option<S> => {
@@ -1381,9 +1354,6 @@ export const getOption: {
  * When both contexts contain the same service key, the service from `that`
  * overrides the service from `self`.
  *
- * @param self - The first `Context` to merge.
- * @param that - The second `Context` to merge.
- *
  * **Example** (Merging two contexts)
  *
  * ```ts
@@ -1403,7 +1373,7 @@ export const getOption: {
  * ```
  *
  * @category Utils
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const merge: {
   /**
@@ -1414,9 +1384,6 @@ export const merge: {
    * When both contexts contain the same service key, the service from `that`
    * overrides the service from `self`.
    *
-   * @param self - The first `Context` to merge.
-   * @param that - The second `Context` to merge.
-   *
    * **Example** (Merging two contexts)
    *
    * ```ts
@@ -1436,7 +1403,7 @@ export const merge: {
    * ```
    *
    * @category Utils
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <R1>(that: Context<R1>): <Services>(self: Context<Services>) => Context<R1 | Services>
   /**
@@ -1447,9 +1414,6 @@ export const merge: {
    * When both contexts contain the same service key, the service from `that`
    * overrides the service from `self`.
    *
-   * @param self - The first `Context` to merge.
-   * @param that - The second `Context` to merge.
-   *
    * **Example** (Merging two contexts)
    *
    * ```ts
@@ -1469,7 +1433,7 @@ export const merge: {
    * ```
    *
    * @category Utils
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <Services, R1>(self: Context<Services>, that: Context<R1>): Context<Services | R1>
 } = dual(2, <Services, R1>(self: Context<Services>, that: Context<R1>): Context<Services | R1> => {
@@ -1513,6 +1477,7 @@ export const merge: {
  * assert.deepStrictEqual(Context.get(context, Host), { HOST: "localhost" })
  * ```
  *
+ * @category combining
  * @since 3.12.0
  */
 export const mergeAll = <T extends Array<unknown>>(
@@ -1530,13 +1495,10 @@ export const mergeAll = <T extends Array<unknown>>(
 /**
  * Returns a new `Context` that contains only the specified services.
  *
- * @param self - The `Context` to prune services from.
- * @param services - The list of `Service`s to be included in the new `Context`.
- *
  * **Example** (Picking services from a context)
  *
  * ```ts
- * import { Option, pipe, Context } from "effect"
+ * import { Context, Option, pipe } from "effect"
  * import * as assert from "node:assert"
  *
  * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1557,7 +1519,7 @@ export const mergeAll = <T extends Array<unknown>>(
  * ```
  *
  * @category Utils
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const pick = <S extends ReadonlyArray<Key<any, any>>>(
   ...services: S
@@ -1577,7 +1539,7 @@ export const pick = <S extends ReadonlyArray<Key<any, any>>>(
  * **Example** (Omitting services from a context)
  *
  * ```ts
- * import { Option, pipe, Context } from "effect"
+ * import { Context, Option, pipe } from "effect"
  * import * as assert from "node:assert"
  *
  * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1598,7 +1560,7 @@ export const pick = <S extends ReadonlyArray<Key<any, any>>>(
  * ```
  *
  * @category Utils
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const omit = <S extends ReadonlyArray<Key<any, any>>>(
   ...keys: S
@@ -1693,8 +1655,8 @@ const withMapUnsafe = <Services, B>(self: Context<Services>, f: (map: Map<string
  * const customLogger = Context.get(customContext, LoggerRef)
  * ```
  *
- * @category References
- * @since 4.0.0
+ * @category references
+ * @since 3.11.0
  */
 export const Reference: <Service>(
   key: string,

package/src/Cron.ts

@@ -506,7 +506,7 @@ export class CronParseError extends Data.TaggedError("CronParseError")<{
  * ```
  *
  * @category guards
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isCronParseError = (u: unknown): u is CronParseError => hasProperty(u, CronParseErrorTypeId)
 
@@ -539,8 +539,6 @@ export const isCronParseError = (u: unknown): u is CronParseError => hasProperty
  * )
  * ```
  *
- * @param cron - The cron expression to parse.
- *
  * @category constructors
  * @since 2.0.0
  */
@@ -596,7 +594,7 @@ export const parse = (cron: string, tz?: DateTime.TimeZone | string): Result.Res
  * ```
  *
  * @category constructors
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const parseUnsafe = (cron: string, tz?: DateTime.TimeZone | string): Cron => Result.getOrThrow(parse(cron, tz))
 
@@ -703,7 +701,7 @@ export const next = (cron: Cron, now?: DateTime.DateTime.Input): Date => {
  * Returns the previous scheduled date/time for the given Cron instance.
  *
  * @category utils
- * @since 4.0.0
+ * @since 3.20.0
  */
 export const prev = (cron: Cron, now?: DateTime.DateTime.Input): Date => {
   return stepCron(cron, now, "prev")