effect 3.10.18 → 3.11.0

package/src/Struct.ts

@@ -14,10 +14,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
  */
@@ -26,10 +28,12 @@ export 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
    */
@@ -40,10 +44,12 @@ export 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
    */
@@ -68,10 +74,12 @@ export 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
  */
@@ -80,10 +88,12 @@ export 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
    */
@@ -94,10 +104,12 @@ export 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
    */
@@ -120,6 +132,7 @@ export const omit: {
  * Alias of {@link Equivalence.struct}.
  *
  * @example
+ * ```ts
  * import { Struct, String, Number } from "effect"
  *
  * const PersonEquivalence = Struct.getEquivalence({
@@ -135,6 +148,7 @@ export const omit: {
  *   PersonEquivalence({ name: "John", age: 25 }, { name: "John", age: 40 }),
  *   false
  * )
+ * ```
  *
  * @category combinators
  * @since 2.0.0
@@ -171,6 +185,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(
@@ -183,6 +198,7 @@ type PartialTransform<O, T> = {
  *   ),
  *   { a: 1, b: 2, c: 3 }
  * )
+ * ```
  *
  * @since 2.0.0
  */
@@ -192,6 +208,7 @@ export 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(
@@ -204,6 +221,7 @@ export const evolve: {
    *   ),
    *   { a: 1, b: 2, c: 3 }
    * )
+   * ```
    *
    * @since 2.0.0
    */
@@ -213,6 +231,7 @@ export 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(
@@ -225,6 +244,7 @@ export const evolve: {
    *   ),
    *   { a: 1, b: 2, c: 3 }
    * )
+   * ```
    *
    * @since 2.0.0
    */
@@ -247,11 +267,13 @@ export 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
  */
@@ -263,6 +285,7 @@ export const get =
  * Retrieves the object keys that are strings in a typed manner
  *
  * @example
+ * ```ts
  * import { Struct } from "effect"
  *
  * const symbol: unique symbol = Symbol()
@@ -276,6 +299,7 @@ export const get =
  * const keys: Array<"a" | "b"> = Struct.keys(value)
  *
  * assert.deepStrictEqual(keys, ["a", "b"])
+ * ```
  *
  * @since 3.6.0
  */

package/src/Symbol.ts

@@ -11,10 +11,12 @@ import * as predicate from "./Predicate.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