effect 3.10.18 → 3.11.0

package/dist/dts/Struct.d.ts

@@ -10,10 +10,12 @@ import type { MatchRecord, Simplify } from "./Types.js";
  * Create a new object by picking properties of an existing object.
  *
  * @example
+ * ```ts
  * import { pipe, Struct } from "effect"
  *
  * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.pick("a", "b")), { a: "a", b: 1 })
  * assert.deepStrictEqual(Struct.pick({ a: "a", b: 1, c: true }, "a", "b"), { a: "a", b: 1 })
+ * ```
  *
  * @since 2.0.0
  */
@@ -22,10 +24,12 @@ export declare const pick: {
      * Create a new object by picking properties of an existing object.
      *
      * @example
+     * ```ts
      * import { pipe, Struct } from "effect"
      *
      * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.pick("a", "b")), { a: "a", b: 1 })
      * assert.deepStrictEqual(Struct.pick({ a: "a", b: 1, c: true }, "a", "b"), { a: "a", b: 1 })
+     * ```
      *
      * @since 2.0.0
      */
@@ -38,10 +42,12 @@ export declare const pick: {
      * Create a new object by picking properties of an existing object.
      *
      * @example
+     * ```ts
      * import { pipe, Struct } from "effect"
      *
      * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.pick("a", "b")), { a: "a", b: 1 })
      * assert.deepStrictEqual(Struct.pick({ a: "a", b: 1, c: true }, "a", "b"), { a: "a", b: 1 })
+     * ```
      *
      * @since 2.0.0
      */
@@ -53,10 +59,12 @@ export declare const pick: {
  * Create a new object by omitting properties of an existing object.
  *
  * @example
+ * ```ts
  * import { pipe, Struct } from "effect"
  *
  * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.omit("c")), { a: "a", b: 1 })
  * assert.deepStrictEqual(Struct.omit({ a: "a", b: 1, c: true }, "c"), { a: "a", b: 1 })
+ * ```
  *
  * @since 2.0.0
  */
@@ -65,10 +73,12 @@ export declare const omit: {
      * Create a new object by omitting properties of an existing object.
      *
      * @example
+     * ```ts
      * import { pipe, Struct } from "effect"
      *
      * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.omit("c")), { a: "a", b: 1 })
      * assert.deepStrictEqual(Struct.omit({ a: "a", b: 1, c: true }, "c"), { a: "a", b: 1 })
+     * ```
      *
      * @since 2.0.0
      */
@@ -79,10 +89,12 @@ export declare const omit: {
      * Create a new object by omitting properties of an existing object.
      *
      * @example
+     * ```ts
      * import { pipe, Struct } from "effect"
      *
      * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.omit("c")), { a: "a", b: 1 })
      * assert.deepStrictEqual(Struct.omit({ a: "a", b: 1, c: true }, "c"), { a: "a", b: 1 })
+     * ```
      *
      * @since 2.0.0
      */
@@ -95,6 +107,7 @@ export declare const omit: {
  * Alias of {@link Equivalence.struct}.
  *
  * @example
+ * ```ts
  * import { Struct, String, Number } from "effect"
  *
  * const PersonEquivalence = Struct.getEquivalence({
@@ -110,6 +123,7 @@ export declare const omit: {
  *   PersonEquivalence({ name: "John", age: 25 }, { name: "John", age: 40 }),
  *   false
  * )
+ * ```
  *
  * @category combinators
  * @since 2.0.0
@@ -142,6 +156,7 @@ type PartialTransform<O, T> = {
  * If no transformation function is provided for a key, it will return the origional value for that key.
  *
  * @example
+ * ```ts
  * import { pipe, Struct } from "effect"
  *
  * assert.deepStrictEqual(
@@ -154,6 +169,7 @@ type PartialTransform<O, T> = {
  *   ),
  *   { a: 1, b: 2, c: 3 }
  * )
+ * ```
  *
  * @since 2.0.0
  */
@@ -163,6 +179,7 @@ export declare const evolve: {
      * If no transformation function is provided for a key, it will return the origional value for that key.
      *
      * @example
+     * ```ts
      * import { pipe, Struct } from "effect"
      *
      * assert.deepStrictEqual(
@@ -175,6 +192,7 @@ export declare const evolve: {
      *   ),
      *   { a: 1, b: 2, c: 3 }
      * )
+     * ```
      *
      * @since 2.0.0
      */
@@ -184,6 +202,7 @@ export declare const evolve: {
      * If no transformation function is provided for a key, it will return the origional value for that key.
      *
      * @example
+     * ```ts
      * import { pipe, Struct } from "effect"
      *
      * assert.deepStrictEqual(
@@ -196,6 +215,7 @@ export declare const evolve: {
      *   ),
      *   { a: 1, b: 2, c: 3 }
      * )
+     * ```
      *
      * @since 2.0.0
      */
@@ -205,11 +225,13 @@ export declare const evolve: {
  * Retrieves the value associated with the specified key from a struct.
  *
  * @example
+ * ```ts
  * import { pipe, Struct } from "effect"
  *
  * const value = pipe({ a: 1, b: 2 }, Struct.get("a"))
  *
  * assert.deepStrictEqual(value, 1)
+ * ```
  *
  * @since 2.0.0
  */
@@ -218,6 +240,7 @@ export declare const get: <K extends PropertyKey>(key: K) => <S extends { [P in
  * Retrieves the object keys that are strings in a typed manner
  *
  * @example
+ * ```ts
  * import { Struct } from "effect"
  *
  * const symbol: unique symbol = Symbol()
@@ -231,6 +254,7 @@ export declare const get: <K extends PropertyKey>(key: K) => <S extends { [P in
  * const keys: Array<"a" | "b"> = Struct.keys(value)
  *
  * assert.deepStrictEqual(keys, ["a", "b"])
+ * ```
  *
  * @since 3.6.0
  */

package/dist/dts/Struct.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Struct.d.ts","sourceRoot":"","sources":["../../src/Struct.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAEvD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;;;;;;;;OAUG;IACH,CAAC,IAAI,SAAS,KAAK,CAAC,WAAW,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,SAAS;SAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG;KAAE,EACxF,CAAC,EAAE,CAAC,KACD,WAAW,CAAC,CAAC,EAAE;SAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;KAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IACpF;;;;;;;;;;OAUG;IACH,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,EAC5C,CAAC,EAAE,CAAC,EACJ,GAAG,IAAI,EAAE,IAAI,GACZ,WAAW,CAAC,CAAC,EAAE;SAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;KAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;CAYnF,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;;;;;;;;OAUG;IACH,CAAC,IAAI,SAAS,KAAK,CAAC,WAAW,CAAC,EAC9B,GAAG,IAAI,EAAE,IAAI,GACZ,CAAC,CAAC,SAAS;SAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG;KAAE,EAAE,CAAC,EAAE,CAAC,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACrF;;;;;;;;;;OAUG;IACH,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAUtG,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAClF,aAAa,EAAE,CAAC,KACb,WAAW,CAAC,WAAW,CAC1B;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,CACtE,CAAA;AAEtB;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,EAAE,CAAC,CAAC,SAAS;IAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;CAAE,EAC1E,MAAM,EAAE,CAAC,KACN,KAAK,CAAC,KAAK,CAAC;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,CAAgB,CAAA;AAEtG,KAAK,WAAW,CAAC,CAAC,EAAE,CAAC,IACjB,OAAO,GACP;KACC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACvG,CAAA;AACH,KAAK,gBAAgB,CAAC,CAAC,EAAE,CAAC,IAAI;KAC3B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,OAAO;CAChG,CAAA;AACD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAChE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CAa7D,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,GAAG,GACb,CAAC,SAAS,WAAW,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAE,KAAK,CAAC,KAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CACtG,CAAA;AAEV;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,EAAE,KAAK,CAAC,KAAG,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAgD,CAAA"}
+{"version":3,"file":"Struct.d.ts","sourceRoot":"","sources":["../../src/Struct.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAEvD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;;;;;;;;;;OAYG;IACH,CAAC,IAAI,SAAS,KAAK,CAAC,WAAW,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,SAAS;SAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG;KAAE,EACxF,CAAC,EAAE,CAAC,KACD,WAAW,CAAC,CAAC,EAAE;SAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;KAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IACpF;;;;;;;;;;;;OAYG;IACH,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,EAC5C,CAAC,EAAE,CAAC,EACJ,GAAG,IAAI,EAAE,IAAI,GACZ,WAAW,CAAC,CAAC,EAAE;SAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;KAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;CAYnF,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;;;;;;;;;;OAYG;IACH,CAAC,IAAI,SAAS,KAAK,CAAC,WAAW,CAAC,EAC9B,GAAG,IAAI,EAAE,IAAI,GACZ,CAAC,CAAC,SAAS;SAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG;KAAE,EAAE,CAAC,EAAE,CAAC,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACrF;;;;;;;;;;;;OAYG;IACH,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAUtG,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAClF,aAAa,EAAE,CAAC,KACb,WAAW,CAAC,WAAW,CAC1B;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,CACtE,CAAA;AAEtB;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,EAAE,CAAC,CAAC,SAAS;IAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;CAAE,EAC1E,MAAM,EAAE,CAAC,KACN,KAAK,CAAC,KAAK,CAAC;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,CAAgB,CAAA;AAEtG,KAAK,WAAW,CAAC,CAAC,EAAE,CAAC,IACjB,OAAO,GACP;KACC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACvG,CAAA;AACH,KAAK,gBAAgB,CAAC,CAAC,EAAE,CAAC,IAAI;KAC3B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,OAAO;CAChG,CAAA;AACD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAChE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CAa7D,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,GAAG,GACb,CAAC,SAAS,WAAW,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAE,KAAK,CAAC,KAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CACtG,CAAA;AAEV;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,EAAE,KAAK,CAAC,KAAG,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAgD,CAAA"}

package/dist/dts/Symbol.d.ts

@@ -8,10 +8,12 @@ import * as equivalence from "./Equivalence.js";
  * @param input - The value to test.
  *
  * @example
+ * ```ts
  * import { Predicate } from "effect"
  *
  * assert.deepStrictEqual(Predicate.isSymbol(Symbol.for("a")), true)
  * assert.deepStrictEqual(Predicate.isSymbol("a"), false)
+ * ```
  *
  * @category guards
  * @since 2.0.0

package/dist/dts/Symbol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Symbol.d.ts","sourceRoot":"","sources":["../../src/Symbol.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAG/C;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,QAAQ,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,IAAI,MAA2B,CAAA;AAEvE;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC,MAAM,CAAsB,CAAA"}
+{"version":3,"file":"Symbol.d.ts","sourceRoot":"","sources":["../../src/Symbol.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAG/C;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,QAAQ,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,IAAI,MAA2B,CAAA;AAEvE;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC,MAAM,CAAsB,CAAA"}