effect 3.13.7 → 3.13.9

package/src/Context.ts

@@ -142,10 +142,9 @@ export declare namespace Tag {
 /**
  * Creates a new `Tag` instance with an optional key parameter.
  *
- * @param key - A key that will be used to compare tags.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Context } from "effect"
  *
  * assert.strictEqual(Context.GenericTag("PORT").key === Context.GenericTag("PORT").key, true)
@@ -191,10 +190,9 @@ export const unsafeMake: <Services>(unsafeMap: Map<string, any>) => Context<Serv
 /**
  * Checks if the provided argument is a `Context`.
  *
- * @param input - The value to be checked if it is a `Context`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Context } from "effect"
  *
  * assert.strictEqual(Context.isContext(Context.empty()), true)
@@ -208,10 +206,9 @@ export const isContext: (input: unknown) => input is Context<never> = internal.i
 /**
  * Checks if the provided argument is a `Tag`.
  *
- * @param input - The value to be checked if it is a `Tag`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Context } from "effect"
  *
  * assert.strictEqual(Context.isTag(Context.GenericTag("Tag")), true)
@@ -225,7 +222,6 @@ export const isTag: (input: unknown) => input is Tag<any, any> = internal.isTag
 /**
  * Checks if the provided argument is a `Reference`.
  *
- * @param input - The value to be checked if it is a `Reference`.
  * @since 3.11.0
  * @category guards
  * @experimental
@@ -237,6 +233,7 @@ export const isReference: (u: unknown) => u is Reference<any, any> = internal.is
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Context } from "effect"
  *
  * assert.strictEqual(Context.isContext(Context.empty()), true)
@@ -252,6 +249,7 @@ export const empty: () => Context<never> = internal.empty
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Context } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -272,6 +270,7 @@ export const make: <T extends Tag<any, any>>(tag: T, service: Tag.Service<T>) =>
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Context, pipe } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -296,6 +295,7 @@ export const add: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Context, pipe } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -320,6 +320,7 @@ export const add: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Context, pipe } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -344,11 +345,9 @@ export const add: {
 /**
  * Get a service from the context that corresponds to the given tag.
  *
- * @param self - The `Context` to search for the service.
- * @param tag - The `Tag` of the service to retrieve.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, Context } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -369,11 +368,9 @@ export const get: {
   /**
    * Get a service from the context that corresponds to the given tag.
    *
-   * @param self - The `Context` to search for the service.
-   * @param tag - The `Tag` of the service to retrieve.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -394,11 +391,9 @@ export const get: {
   /**
    * Get a service from the context that corresponds to the given tag.
    *
-   * @param self - The `Context` to search for the service.
-   * @param tag - The `Tag` of the service to retrieve.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -419,11 +414,9 @@ export const get: {
   /**
    * Get a service from the context that corresponds to the given tag.
    *
-   * @param self - The `Context` to search for the service.
-   * @param tag - The `Tag` of the service to retrieve.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -444,11 +437,9 @@ export const get: {
   /**
    * Get a service from the context that corresponds to the given tag.
    *
-   * @param self - The `Context` to search for the service.
-   * @param tag - The `Tag` of the service to retrieve.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -500,11 +491,9 @@ export const getOrElse: {
  *
  * For a safer version see {@link getOption}.
  *
- * @param self - The `Context` to search for the service.
- * @param tag - The `Tag` of the service to retrieve.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Context } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -526,11 +515,9 @@ export const unsafeGet: {
    *
    * For a safer version see {@link getOption}.
    *
-   * @param self - The `Context` to search for the service.
-   * @param tag - The `Tag` of the service to retrieve.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -552,11 +539,9 @@ export const unsafeGet: {
    *
    * For a safer version see {@link getOption}.
    *
-   * @param self - The `Context` to search for the service.
-   * @param tag - The `Tag` of the service to retrieve.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -578,11 +563,9 @@ export const unsafeGet: {
  * Get the value associated with the specified tag from the context wrapped in an `Option` object. If the tag is not
  * found, the `Option` object will be `None`.
  *
- * @param self - The `Context` to search for the service.
- * @param tag - The `Tag` of the service to retrieve.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Context, Option } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -602,11 +585,9 @@ export const getOption: {
    * Get the value associated with the specified tag from the context wrapped in an `Option` object. If the tag is not
    * found, the `Option` object will be `None`.
    *
-   * @param self - The `Context` to search for the service.
-   * @param tag - The `Tag` of the service to retrieve.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Context, Option } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -626,11 +607,9 @@ export const getOption: {
    * Get the value associated with the specified tag from the context wrapped in an `Option` object. If the tag is not
    * found, the `Option` object will be `None`.
    *
-   * @param self - The `Context` to search for the service.
-   * @param tag - The `Tag` of the service to retrieve.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Context, Option } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -651,11 +630,9 @@ export const getOption: {
 /**
  * Merges two `Context`s, returning a new `Context` containing the services of both.
  *
- * @param self - The first `Context` to merge.
- * @param that - The second `Context` to merge.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Context } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -676,11 +653,9 @@ export const merge: {
   /**
    * Merges two `Context`s, returning a new `Context` containing the services of both.
    *
-   * @param self - The first `Context` to merge.
-   * @param that - The second `Context` to merge.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -701,11 +676,9 @@ export const merge: {
   /**
    * Merges two `Context`s, returning a new `Context` containing the services of both.
    *
-   * @param self - The first `Context` to merge.
-   * @param that - The second `Context` to merge.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -728,10 +701,9 @@ export const merge: {
 /**
  * Merges any number of `Context`s, returning a new `Context` containing the services of all.
  *
- * @param ctxs - The `Context`s to merge.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Context } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -758,11 +730,9 @@ 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 tags - The list of `Tag`s to be included in the new `Context`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, Context, Option } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -796,6 +766,7 @@ export const omit: <Services, S extends Array<ValidTagsById<Services>>>(
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Context, Layer } from "effect"
  *
  * class MyTag extends Context.Tag("MyTag")<
@@ -824,6 +795,7 @@ export const Tag: <const Id extends string>(id: Id) => <Self, Shape>() => TagCla
  * @example
  * ```ts
  * // Title: Declaring a Tag with a default value
+ * import * as assert from "node:assert"
  * import { Context, Effect } from "effect"
  *
  * class SpecialNumber extends Context.Reference<SpecialNumber>()(

package/src/Cron.ts

@@ -106,8 +106,6 @@ const CronProto = {
 /**
  * Checks if a given value is a `Cron` instance.
  *
- * @param u - The value to check.
- *
  * @since 2.0.0
  * @category guards
  */
@@ -116,8 +114,6 @@ export const isCron = (u: unknown): u is Cron => hasProperty(u, TypeId)
 /**
  * Creates a `Cron` instance.
  *
- * @param constraints - The cron constraints.
- *
  * @since 2.0.0
  * @category constructors
  */
@@ -216,8 +212,6 @@ export class ParseError extends Data.TaggedError("CronParseError")<{
 /**
  * Returns `true` if the specified value is an `ParseError`, `false` otherwise.
  *
- * @param u - The value to check.
- *
  * @since 2.0.0
  * @category guards
  */
@@ -226,10 +220,9 @@ export const isParseError = (u: unknown): u is ParseError => hasProperty(u, Pars
 /**
  * Parses a cron expression into a `Cron` instance.
  *
- * @param cron - The cron expression to parse.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Cron, Either } from "effect"
  *
  * // At 04:00 on every day-of-month from 8 through 14.
@@ -327,13 +320,9 @@ export const unsafeParse = (cron: string, tz?: DateTime.TimeZone | string): Cron
 /**
  * Checks if a given `Date` falls within an active `Cron` time window.
  *
- * @throws `IllegalArgumentException` if the given `DateTime.Input` is invalid.
- *
- * @param cron - The `Cron` instance.
- * @param date - The `Date` to check against.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Cron, Either } from "effect"
  *
  * const cron = Either.getOrThrow(Cron.parse("0 4 8-14 * *"))
@@ -341,6 +330,8 @@ export const unsafeParse = (cron: string, tz?: DateTime.TimeZone | string): Cron
  * assert.deepStrictEqual(Cron.match(cron, new Date("2021-01-08 05:00:00")), false)
  * ```
  *
+ * @throws `IllegalArgumentException` if the given `DateTime.Input` is invalid.
+ *
  * @since 2.0.0
  */
 export const match = (cron: Cron, date: DateTime.DateTime.Input): boolean => {
@@ -387,11 +378,9 @@ const daysInMonth = (date: Date): number =>
  *
  * Uses the current time as a starting point if no value is provided for `now`.
  *
- * @throws `IllegalArgumentException` if the given `DateTime.Input` is invalid.
- * @throws `Error` if the next run date cannot be found within 10,000 iterations.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Cron, Either } from "effect"
  *
  * const after = new Date("2021-01-01 00:00:00")
@@ -399,14 +388,14 @@ const daysInMonth = (date: Date): number =>
  * assert.deepStrictEqual(Cron.next(cron, after), new Date("2021-01-08 04:00:00"))
  * ```
  *
- * @param cron - The `Cron` instance.
- * @param now - The `Date` to start searching from.
+ * @throws `IllegalArgumentException` if the given `DateTime.Input` is invalid.
+ * @throws `Error` if the next run date cannot be found within 10,000 iterations.
  *
  * @since 2.0.0
  */
-export const next = (cron: Cron, now?: DateTime.DateTime.Input): Date => {
+export const next = (cron: Cron, startFrom?: DateTime.DateTime.Input): Date => {
   const tz = Option.getOrUndefined(cron.tz)
-  const zoned = dateTime.unsafeMakeZoned(now ?? new Date(), {
+  const zoned = dateTime.unsafeMakeZoned(startFrom ?? new Date(), {
     timeZone: tz
   })
 
@@ -529,14 +518,11 @@ export const next = (cron: Cron, now?: DateTime.DateTime.Input): Date => {
 /**
  * Returns an `IterableIterator` which yields the sequence of `Date`s that match the `Cron` instance.
  *
- * @param cron - The `Cron` instance.
- * @param now - The `Date` to start searching from.
- *
  * @since 2.0.0
  */
-export const sequence = function*(cron: Cron, now?: DateTime.DateTime.Input): IterableIterator<Date> {
+export const sequence = function*(cron: Cron, startFrom?: DateTime.DateTime.Input): IterableIterator<Date> {
   while (true) {
-    yield now = next(cron, now)
+    yield startFrom = next(cron, startFrom)
   }
 }
 

package/src/Data.ts

@@ -28,6 +28,7 @@ export declare namespace Case {
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Data, Equal } from "effect"
  *
  * const alice = Data.struct({ name: "Alice", age: 30 })
@@ -56,6 +57,7 @@ export const unsafeStruct = <A extends Record<string, any>>(as: A): { readonly [
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Data, Equal } from "effect"
  *
  * const alice = Data.tuple("Alice", 30)
@@ -77,6 +79,7 @@ export const tuple = <As extends ReadonlyArray<any>>(...as: As): Readonly<As> =>
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Data, Equal } from "effect"
  *
  * const alice = Data.struct({ name: "Alice", age: 30 })
@@ -117,6 +120,7 @@ export {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Data, Equal } from "effect"
    *
    * interface Person {
@@ -147,6 +151,7 @@ export {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Data } from "effect"
  *
  * interface Person {
@@ -178,6 +183,7 @@ export const tagged = <A extends { readonly _tag: string }>(
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Data, Equal } from "effect"
  *
  * class Person extends Data.Class<{ readonly name: string }> {}
@@ -205,6 +211,7 @@ export const Class: new<A extends Record<string, any> = {}>(
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Data, Equal } from "effect"
  *
  * class Person extends Data.TaggedClass("Person")<{ readonly name: string }> {}
@@ -249,6 +256,7 @@ export const Structural: new<A>(
  * Create a tagged enum data type, which is a union of `Data` structs.
  *
  * ```ts
+ * import * as assert from "node:assert"
  * import { Data } from "effect"
  *
  * type HttpError = Data.TaggedEnum<{

package/src/DateTime.ts

@@ -1272,6 +1272,7 @@ export const toPartsUtc: (self: DateTime) => DateTime.PartsWithWeekday = Interna
  * @category parts
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { DateTime } from "effect"
  *
  * const now = DateTime.unsafeMake({ year: 2024 })
@@ -1289,6 +1290,7 @@ export const getPartUtc: {
    * @category parts
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { DateTime } from "effect"
    *
    * const now = DateTime.unsafeMake({ year: 2024 })
@@ -1306,6 +1308,7 @@ export const getPartUtc: {
    * @category parts
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { DateTime } from "effect"
    *
    * const now = DateTime.unsafeMake({ year: 2024 })
@@ -1325,6 +1328,7 @@ export const getPartUtc: {
  * @category parts
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { DateTime } from "effect"
  *
  * const now = DateTime.unsafeMakeZoned({ year: 2024 }, { timeZone: "Europe/London" })
@@ -1342,6 +1346,7 @@ export const getPart: {
    * @category parts
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { DateTime } from "effect"
    *
    * const now = DateTime.unsafeMakeZoned({ year: 2024 }, { timeZone: "Europe/London" })
@@ -1359,6 +1364,7 @@ export const getPart: {
    * @category parts
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { DateTime } from "effect"
    *
    * const now = DateTime.unsafeMakeZoned({ year: 2024 }, { timeZone: "Europe/London" })

package/src/Duration.ts

@@ -1001,8 +1001,6 @@ export const format = (self: DurationInput): string => {
  *
  * Milliseconds and nanoseconds are expressed as fractional seconds.
  *
- * @throws `RangeError` If the duration is not finite.
- *
  * @example
  * ```ts
  * import { Duration } from "effect"
@@ -1012,6 +1010,8 @@ export const format = (self: DurationInput): string => {
  * Duration.unsafeFormatIso(Duration.millis(1500)) // => "PT1.5S"
  * ```
  *
+ * @throws `RangeError` If the duration is not finite.
+ *
  * @since 3.13.0
  * @category conversions
  */