effect 3.10.17 → 3.10.19

package/src/Context.ts

@@ -101,9 +101,11 @@ export declare namespace Tag {
  * @param key - A key that will be used to compare tags.
  *
  * @example
+ * ```ts
  * import { Context } from "effect"
  *
  * assert.strictEqual(Context.GenericTag("PORT").key === Context.GenericTag("PORT").key, true)
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -148,9 +150,11 @@ export const unsafeMake: <Services>(unsafeMap: Map<string, any>) => Context<Serv
  * @param input - The value to be checked if it is a `Context`.
  *
  * @example
+ * ```ts
  * import { Context } from "effect"
  *
  * assert.strictEqual(Context.isContext(Context.empty()), true)
+ * ```
  *
  * @since 2.0.0
  * @category guards
@@ -163,9 +167,11 @@ export const isContext: (input: unknown) => input is Context<never> = internal.i
  * @param input - The value to be checked if it is a `Tag`.
  *
  * @example
+ * ```ts
  * import { Context } from "effect"
  *
  * assert.strictEqual(Context.isTag(Context.GenericTag("Tag")), true)
+ * ```
  *
  * @since 2.0.0
  * @category guards
@@ -176,9 +182,11 @@ export const isTag: (input: unknown) => input is Tag<any, any> = internal.isTag
  * Returns an empty `Context`.
  *
  * @example
+ * ```ts
  * import { Context } from "effect"
  *
  * assert.strictEqual(Context.isContext(Context.empty()), true)
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -189,6 +197,7 @@ export const empty: () => Context<never> = internal.empty
  * Creates a new `Context` with a single service associated to the tag.
  *
  * @example
+ * ```ts
  * import { Context } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -196,6 +205,7 @@ export const empty: () => Context<never> = internal.empty
  * const Services = Context.make(Port, { PORT: 8080 })
  *
  * assert.deepStrictEqual(Context.get(Services, Port), { PORT: 8080 })
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -207,6 +217,7 @@ export const make: <T extends Tag<any, any>>(tag: T, service: Tag.Service<T>) =>
  * Adds a service to a given `Context`.
  *
  * @example
+ * ```ts
  * import { Context, pipe } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -221,6 +232,7 @@ export const make: <T extends Tag<any, any>>(tag: T, service: Tag.Service<T>) =>
  *
  * assert.deepStrictEqual(Context.get(Services, Port), { PORT: 8080 })
  * assert.deepStrictEqual(Context.get(Services, Timeout), { TIMEOUT: 5000 })
+ * ```
  *
  * @since 2.0.0
  */
@@ -229,6 +241,7 @@ export const add: {
    * Adds a service to a given `Context`.
    *
    * @example
+   * ```ts
    * import { Context, pipe } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -243,6 +256,7 @@ export const add: {
    *
    * assert.deepStrictEqual(Context.get(Services, Port), { PORT: 8080 })
    * assert.deepStrictEqual(Context.get(Services, Timeout), { TIMEOUT: 5000 })
+   * ```
    *
    * @since 2.0.0
    */
@@ -254,6 +268,7 @@ export const add: {
    * Adds a service to a given `Context`.
    *
    * @example
+   * ```ts
    * import { Context, pipe } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -268,6 +283,7 @@ export const add: {
    *
    * assert.deepStrictEqual(Context.get(Services, Port), { PORT: 8080 })
    * assert.deepStrictEqual(Context.get(Services, Timeout), { TIMEOUT: 5000 })
+   * ```
    *
    * @since 2.0.0
    */
@@ -285,6 +301,7 @@ export const add: {
  * @param tag - The `Tag` of the service to retrieve.
  *
  * @example
+ * ```ts
  * import { pipe, Context } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -296,6 +313,7 @@ export const add: {
  * )
  *
  * assert.deepStrictEqual(Context.get(Services, Timeout), { TIMEOUT: 5000 })
+ * ```
  *
  * @since 2.0.0
  * @category getters
@@ -308,6 +326,7 @@ export const get: {
    * @param tag - The `Tag` of the service to retrieve.
    *
    * @example
+   * ```ts
    * import { pipe, Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -319,6 +338,7 @@ export const get: {
    * )
    *
    * assert.deepStrictEqual(Context.get(Services, Timeout), { TIMEOUT: 5000 })
+   * ```
    *
    * @since 2.0.0
    * @category getters
@@ -331,6 +351,7 @@ export const get: {
    * @param tag - The `Tag` of the service to retrieve.
    *
    * @example
+   * ```ts
    * import { pipe, Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -342,6 +363,7 @@ export const get: {
    * )
    *
    * assert.deepStrictEqual(Context.get(Services, Timeout), { TIMEOUT: 5000 })
+   * ```
    *
    * @since 2.0.0
    * @category getters
@@ -385,6 +407,7 @@ export const getOrElse: {
  * @param tag - The `Tag` of the service to retrieve.
  *
  * @example
+ * ```ts
  * import { Context } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -394,6 +417,7 @@ export const getOrElse: {
  *
  * assert.deepStrictEqual(Context.unsafeGet(Services, Port), { PORT: 8080 })
  * assert.throws(() => Context.unsafeGet(Services, Timeout))
+ * ```
  *
  * @since 2.0.0
  * @category unsafe
@@ -409,6 +433,7 @@ export const unsafeGet: {
    * @param tag - The `Tag` of the service to retrieve.
    *
    * @example
+   * ```ts
    * import { Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -418,6 +443,7 @@ export const unsafeGet: {
    *
    * assert.deepStrictEqual(Context.unsafeGet(Services, Port), { PORT: 8080 })
    * assert.throws(() => Context.unsafeGet(Services, Timeout))
+   * ```
    *
    * @since 2.0.0
    * @category unsafe
@@ -433,6 +459,7 @@ export const unsafeGet: {
    * @param tag - The `Tag` of the service to retrieve.
    *
    * @example
+   * ```ts
    * import { Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -442,6 +469,7 @@ export const unsafeGet: {
    *
    * assert.deepStrictEqual(Context.unsafeGet(Services, Port), { PORT: 8080 })
    * assert.throws(() => Context.unsafeGet(Services, Timeout))
+   * ```
    *
    * @since 2.0.0
    * @category unsafe
@@ -457,6 +485,7 @@ export const unsafeGet: {
  * @param tag - The `Tag` of the service to retrieve.
  *
  * @example
+ * ```ts
  * import { Context, Option } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -466,6 +495,7 @@ export const unsafeGet: {
  *
  * assert.deepStrictEqual(Context.getOption(Services, Port), Option.some({ PORT: 8080 }))
  * assert.deepStrictEqual(Context.getOption(Services, Timeout), Option.none())
+ * ```
  *
  * @since 2.0.0
  * @category getters
@@ -479,6 +509,7 @@ export const getOption: {
    * @param tag - The `Tag` of the service to retrieve.
    *
    * @example
+   * ```ts
    * import { Context, Option } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -488,6 +519,7 @@ export const getOption: {
    *
    * assert.deepStrictEqual(Context.getOption(Services, Port), Option.some({ PORT: 8080 }))
    * assert.deepStrictEqual(Context.getOption(Services, Timeout), Option.none())
+   * ```
    *
    * @since 2.0.0
    * @category getters
@@ -501,6 +533,7 @@ export const getOption: {
    * @param tag - The `Tag` of the service to retrieve.
    *
    * @example
+   * ```ts
    * import { Context, Option } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -510,6 +543,7 @@ export const getOption: {
    *
    * assert.deepStrictEqual(Context.getOption(Services, Port), Option.some({ PORT: 8080 }))
    * assert.deepStrictEqual(Context.getOption(Services, Timeout), Option.none())
+   * ```
    *
    * @since 2.0.0
    * @category getters
@@ -524,6 +558,7 @@ export const getOption: {
  * @param that - The second `Context` to merge.
  *
  * @example
+ * ```ts
  * import { Context } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -536,6 +571,7 @@ export const getOption: {
  *
  * assert.deepStrictEqual(Context.get(Services, Port), { PORT: 8080 })
  * assert.deepStrictEqual(Context.get(Services, Timeout), { TIMEOUT: 5000 })
+ * ```
  *
  * @since 2.0.0
  */
@@ -547,6 +583,7 @@ export const merge: {
    * @param that - The second `Context` to merge.
    *
    * @example
+   * ```ts
    * import { Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -559,6 +596,7 @@ export const merge: {
    *
    * assert.deepStrictEqual(Context.get(Services, Port), { PORT: 8080 })
    * assert.deepStrictEqual(Context.get(Services, Timeout), { TIMEOUT: 5000 })
+   * ```
    *
    * @since 2.0.0
    */
@@ -570,6 +608,7 @@ export const merge: {
    * @param that - The second `Context` to merge.
    *
    * @example
+   * ```ts
    * import { Context } from "effect"
    *
    * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -582,6 +621,7 @@ export const merge: {
    *
    * assert.deepStrictEqual(Context.get(Services, Port), { PORT: 8080 })
    * assert.deepStrictEqual(Context.get(Services, Timeout), { TIMEOUT: 5000 })
+   * ```
    *
    * @since 2.0.0
    */
@@ -595,6 +635,7 @@ export const merge: {
  * @param tags - The list of `Tag`s to be included in the new `Context`.
  *
  * @example
+ * ```ts
  * import { pipe, Context, Option } from "effect"
  *
  * const Port = Context.GenericTag<{ PORT: number }>("Port")
@@ -609,6 +650,7 @@ export const merge: {
  *
  * assert.deepStrictEqual(Context.getOption(Services, Port), Option.some({ PORT: 8080 }))
  * assert.deepStrictEqual(Context.getOption(Services, Timeout), Option.none())
+ * ```
  *
  * @since 2.0.0
  */
@@ -626,6 +668,7 @@ export const omit: <Services, S extends Array<ValidTagsById<Services>>>(
 
 /**
  * @example
+ * ```ts
  * import { Context, Layer } from "effect"
  *
  * class MyTag extends Context.Tag("MyTag")<
@@ -634,6 +677,7 @@ export const omit: <Services, S extends Array<ValidTagsById<Services>>>(
  * >() {
  *  static Live = Layer.succeed(this, { myNum: 108 })
  * }
+ * ```
  *
  * @since 2.0.0
  * @category constructors

package/src/Cron.ts

@@ -170,6 +170,7 @@ export const isParseError = (u: unknown): u is ParseError => hasProperty(u, Pars
  * @param cron - The cron expression to parse.
  *
  * @example
+ * ```ts
  * import { Cron, Either } from "effect"
  *
  * // At 04:00 on every day-of-month from 8 through 14.
@@ -180,6 +181,7 @@ export const isParseError = (u: unknown): u is ParseError => hasProperty(u, Pars
  *   months: [],
  *   weekdays: []
  * })))
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -207,11 +209,13 @@ export const parse = (cron: string): Either.Either<Cron, ParseError> => {
  * @param date - The `Date` to check against.
  *
  * @example
+ * ```ts
  * import { Cron, Either } from "effect"
  *
  * const cron = Either.getOrThrow(Cron.parse("0 4 8-14 * *"))
  * assert.deepStrictEqual(Cron.match(cron, new Date("2021-01-08 04:00:00")), true)
  * assert.deepStrictEqual(Cron.match(cron, new Date("2021-01-08 05:00:00")), false)
+ * ```
  *
  * @since 2.0.0
  */
@@ -256,11 +260,13 @@ export const match = (cron: Cron, date: Date): boolean => {
  * Uses the current time as a starting point if no value is provided for `now`.
  *
  * @example
+ * ```ts
  * import { Cron, Either } from "effect"
  *
  * const after = new Date("2021-01-01 00:00:00")
  * const cron = Either.getOrThrow(Cron.parse("0 4 8-14 * *"))
  * 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.

package/src/Data.ts

@@ -27,6 +27,7 @@ export declare namespace Case {
 
 /**
  * @example
+ * ```ts
  * import { Data, Equal } from "effect"
  *
  * const alice = Data.struct({ name: "Alice", age: 30 })
@@ -38,6 +39,7 @@ export declare namespace Case {
  *
  * assert.deepStrictEqual(Equal.equals(alice, { name: "Alice", age: 30 }), false)
  * assert.deepStrictEqual(Equal.equals(alice, bob), false)
+ * ```
  *
  * @category constructors
  * @since 2.0.0
@@ -53,6 +55,7 @@ export const unsafeStruct = <A extends Record<string, any>>(as: A): { readonly [
 
 /**
  * @example
+ * ```ts
  * import { Data, Equal } from "effect"
  *
  * const alice = Data.tuple("Alice", 30)
@@ -64,6 +67,7 @@ export const unsafeStruct = <A extends Record<string, any>>(as: A): { readonly [
  *
  * assert.deepStrictEqual(Equal.equals(alice, ["Alice", 30]), false)
  * assert.deepStrictEqual(Equal.equals(alice, bob), false)
+ * ```
  *
  * @category constructors
  * @since 2.0.0
@@ -72,6 +76,7 @@ export const tuple = <As extends ReadonlyArray<any>>(...as: As): Readonly<As> =>
 
 /**
  * @example
+ * ```ts
  * import { Data, Equal } from "effect"
  *
  * const alice = Data.struct({ name: "Alice", age: 30 })
@@ -89,6 +94,7 @@ export const tuple = <As extends ReadonlyArray<any>>(...as: As): Readonly<As> =>
  *   ),
  *   true
  * )
+ * ```
  *
  * @category constructors
  * @since 2.0.0
@@ -110,6 +116,7 @@ export {
    * Provides a constructor for the specified `Case`.
    *
    * @example
+   * ```ts
    * import { Data, Equal } from "effect"
    *
    * interface Person {
@@ -128,6 +135,7 @@ export {
    * assert.deepStrictEqual(Equal.equals(mike1, mike2), true)
    * assert.deepStrictEqual(Equal.equals(mike1, john), false)
    *
+   * ```
    * @since 2.0.0
    * @category constructors
    */
@@ -138,6 +146,7 @@ export {
  * Provides a tagged constructor for the specified `Case`.
  *
  * @example
+ * ```ts
  * import { Data } from "effect"
  *
  * interface Person {
@@ -150,6 +159,7 @@ export {
  * const mike = Person({ name: "Mike" })
  *
  * assert.deepEqual(mike, { _tag: "Person", name: "Mike" })
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -167,6 +177,7 @@ export const tagged = <A extends { readonly _tag: string }>(
  * Provides a constructor for a Case Class.
  *
  * @example
+ * ```ts
  * import { Data, Equal } from "effect"
  *
  * class Person extends Data.Class<{ readonly name: string }> {}
@@ -179,6 +190,7 @@ export const tagged = <A extends { readonly _tag: string }>(
  * // Checking equality
  * assert.deepStrictEqual(Equal.equals(mike1, mike2), true)
  * assert.deepStrictEqual(Equal.equals(mike1, john), false)
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -192,6 +204,7 @@ export const Class: new<A extends Record<string, any> = {}>(
  * Provides a Tagged constructor for a Case Class.
  *
  * @example
+ * ```ts
  * import { Data, Equal } from "effect"
  *
  * class Person extends Data.TaggedClass("Person")<{ readonly name: string }> {}
@@ -206,6 +219,7 @@ export const Class: new<A extends Record<string, any> = {}>(
  * assert.deepStrictEqual(Equal.equals(mike1, john), false)
  *
  * assert.deepStrictEqual(mike1._tag, "Person")
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -403,6 +417,7 @@ export declare namespace TaggedEnum {
  * the constructor.
  *
  * @example
+ * ```ts
  * import { Data } from "effect"
  *
  * const { BadRequest, NotFound } = Data.taggedEnum<
@@ -411,6 +426,7 @@ export declare namespace TaggedEnum {
  * >()
  *
  * const notFound = NotFound({ status: 404, message: "Not Found" })
+ * ```
  *
  * @example
  * import { Data } from "effect"
@@ -437,6 +453,7 @@ export const taggedEnum: {
    * the constructor.
    *
    * @example
+   * ```ts
    * import { Data } from "effect"
    *
    * const { BadRequest, NotFound } = Data.taggedEnum<
@@ -445,6 +462,7 @@ export const taggedEnum: {
    * >()
    *
    * const notFound = NotFound({ status: 404, message: "Not Found" })
+   * ```
    *
    * @example
    * import { Data } from "effect"
@@ -482,6 +500,7 @@ export const taggedEnum: {
    * the constructor.
    *
    * @example
+   * ```ts
    * import { Data } from "effect"
    *
    * const { BadRequest, NotFound } = Data.taggedEnum<
@@ -490,6 +509,7 @@ export const taggedEnum: {
    * >()
    *
    * const notFound = NotFound({ status: 404, message: "Not Found" })
+   * ```
    *
    * @example
    * import { Data } from "effect"
@@ -527,6 +547,7 @@ export const taggedEnum: {
    * the constructor.
    *
    * @example
+   * ```ts
    * import { Data } from "effect"
    *
    * const { BadRequest, NotFound } = Data.taggedEnum<
@@ -535,6 +556,7 @@ export const taggedEnum: {
    * >()
    *
    * const notFound = NotFound({ status: 404, message: "Not Found" })
+   * ```
    *
    * @example
    * import { Data } from "effect"
@@ -572,6 +594,7 @@ export const taggedEnum: {
    * the constructor.
    *
    * @example
+   * ```ts
    * import { Data } from "effect"
    *
    * const { BadRequest, NotFound } = Data.taggedEnum<
@@ -580,6 +603,7 @@ export const taggedEnum: {
    * >()
    *
    * const notFound = NotFound({ status: 404, message: "Not Found" })
+   * ```
    *
    * @example
    * import { Data } from "effect"
@@ -617,6 +641,7 @@ export const taggedEnum: {
    * the constructor.
    *
    * @example
+   * ```ts
    * import { Data } from "effect"
    *
    * const { BadRequest, NotFound } = Data.taggedEnum<
@@ -625,6 +650,7 @@ export const taggedEnum: {
    * >()
    *
    * const notFound = NotFound({ status: 404, message: "Not Found" })
+   * ```
    *
    * @example
    * import { Data } from "effect"