effect 3.13.10 → 3.13.12

package/src/Either.ts

@@ -190,7 +190,7 @@ export const fromNullable: {
 } = dual(
   2,
   <R, L>(self: R, onNullable: (right: R) => L): Either<NonNullable<R>, L> =>
-    self == null ? left(onNullable(self)) : right(self as NonNullable<R>)
+    self == null ? left(onNullable(self)) : right(self)
 )
 
 /**
@@ -1338,10 +1338,6 @@ export const gen: Gen.Gen<EitherTypeLambda, Gen.Adapter<EitherTypeLambda>> = (..
  * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
  * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
  *
- * @see {@link bind}
- * @see {@link bindTo}
- * @see {@link let_ let}
- *
  * @example
  * ```ts
  * import * as assert from "node:assert"
@@ -1356,6 +1352,10 @@ export const gen: Gen.Gen<EitherTypeLambda, Gen.Adapter<EitherTypeLambda>> = (..
  * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
  * ```
  *
+ * @see {@link bind}
+ * @see {@link bindTo}
+ * @see {@link let_ let}
+ *
  * @category do notation
  * @since 2.0.0
  */
@@ -1371,10 +1371,6 @@ export const Do: Either<{}> = right({})
  * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
  * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
  *
- * @see {@link Do}
- * @see {@link bindTo}
- * @see {@link let_ let}
- *
  * @example
  * ```ts
  * import * as assert from "node:assert"
@@ -1389,6 +1385,10 @@ export const Do: Either<{}> = right({})
  * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
  * ```
  *
+ * @see {@link Do}
+ * @see {@link bindTo}
+ * @see {@link let_ let}
+ *
  * @category do notation
  * @since 2.0.0
  */
@@ -1403,10 +1403,6 @@ export const bind: {
    * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
    * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
    *
-   * @see {@link Do}
-   * @see {@link bindTo}
-   * @see {@link let_ let}
-   *
    * @example
    * ```ts
    * import * as assert from "node:assert"
@@ -1421,6 +1417,10 @@ export const bind: {
    * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
    * ```
    *
+   * @see {@link Do}
+   * @see {@link bindTo}
+   * @see {@link let_ let}
+   *
    * @category do notation
    * @since 2.0.0
    */
@@ -1435,10 +1435,6 @@ export const bind: {
    * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
    * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
    *
-   * @see {@link Do}
-   * @see {@link bindTo}
-   * @see {@link let_ let}
-   *
    * @example
    * ```ts
    * import * as assert from "node:assert"
@@ -1453,6 +1449,10 @@ export const bind: {
    * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
    * ```
    *
+   * @see {@link Do}
+   * @see {@link bindTo}
+   * @see {@link let_ let}
+   *
    * @category do notation
    * @since 2.0.0
    */
@@ -1473,10 +1473,6 @@ export const bind: {
  * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
  * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
  *
- * @see {@link Do}
- * @see {@link bind}
- * @see {@link let_ let}
- *
  * @example
  * ```ts
  * import * as assert from "node:assert"
@@ -1491,6 +1487,10 @@ export const bind: {
  * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
  * ```
  *
+ * @see {@link Do}
+ * @see {@link bind}
+ * @see {@link let_ let}
+ *
  * @category do notation
  * @since 2.0.0
  */
@@ -1505,10 +1505,6 @@ export const bindTo: {
    * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
    * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
    *
-   * @see {@link Do}
-   * @see {@link bind}
-   * @see {@link let_ let}
-   *
    * @example
    * ```ts
    * import * as assert from "node:assert"
@@ -1523,6 +1519,10 @@ export const bindTo: {
    * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
    * ```
    *
+   * @see {@link Do}
+   * @see {@link bind}
+   * @see {@link let_ let}
+   *
    * @category do notation
    * @since 2.0.0
    */
@@ -1537,10 +1537,6 @@ export const bindTo: {
    * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
    * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
    *
-   * @see {@link Do}
-   * @see {@link bind}
-   * @see {@link let_ let}
-   *
    * @example
    * ```ts
    * import * as assert from "node:assert"
@@ -1555,6 +1551,10 @@ export const bindTo: {
    * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
    * ```
    *
+   * @see {@link Do}
+   * @see {@link bind}
+   * @see {@link let_ let}
+   *
    * @category do notation
    * @since 2.0.0
    */
@@ -1584,10 +1584,6 @@ export {
    * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
    * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
    *
-   * @see {@link Do}
-   * @see {@link bindTo}
-   * @see {@link bind}
-   *
    * @example
    * ```ts
    * import * as assert from "node:assert"
@@ -1600,8 +1596,12 @@ export {
    *   Either.let("sum", ({ x, y }) => x + y)
    * )
    * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
-   *
    * ```
+   *
+   * @see {@link Do}
+   * @see {@link bindTo}
+   * @see {@link bind}
+   *
    * @category do notation
    * @since 2.0.0
    */

package/src/JSONSchema.ts

@@ -703,8 +703,12 @@ const go = (
             propertyNames = go(parameter, $defs, true, path, options)
             break
           }
-          case "SymbolKeyword":
-            throw new Error(errors_.getJSONSchemaUnsupportedParameterErrorMessage(path, parameter))
+          case "SymbolKeyword": {
+            const indexSignaturePath = path.concat("[symbol]")
+            output.additionalProperties = go(is.type, $defs, true, indexSignaturePath, options)
+            propertyNames = go(parameter, $defs, true, indexSignaturePath, options)
+            break
+          }
         }
       }
       // ---------------------------------------------

package/src/LogLevel.ts

@@ -196,7 +196,7 @@ export const allLevels = core.allLogLevels
  *   }).pipe(LogLevel.locally(LogLevel.Warning))
  * })
  *
- * // Effect.runFork(program)
+ * Effect.runFork(program)
  * // timestamp=... level=INFO fiber=#0 message=message1
  * // timestamp=... level=WARN fiber=#0 message=message2
  * // timestamp=... level=WARN fiber=#0 message=message3
@@ -232,7 +232,7 @@ export const locally: {
    *   }).pipe(LogLevel.locally(LogLevel.Warning))
    * })
    *
-   * // Effect.runFork(program)
+   * Effect.runFork(program)
    * // timestamp=... level=INFO fiber=#0 message=message1
    * // timestamp=... level=WARN fiber=#0 message=message2
    * // timestamp=... level=WARN fiber=#0 message=message3
@@ -268,7 +268,7 @@ export const locally: {
    *   }).pipe(LogLevel.locally(LogLevel.Warning))
    * })
    *
-   * // Effect.runFork(program)
+   * Effect.runFork(program)
    * // timestamp=... level=INFO fiber=#0 message=message1
    * // timestamp=... level=WARN fiber=#0 message=message2
    * // timestamp=... level=WARN fiber=#0 message=message3

package/src/Logger.ts

@@ -97,7 +97,7 @@ export declare namespace Logger {
  *   Effect.provide(Logger.replace(Logger.defaultLogger, logger))
  * )
  *
- * // Effect.runFork(program)
+ * Effect.runFork(program)
  * // [INFO] start
  * // [DEBUG] task1 done
  * // [DEBUG] task2 done
@@ -232,7 +232,7 @@ export const map: {
  *   yield* Effect.log("three")
  * }).pipe(Effect.provide(LoggerLive))
  *
- * // Effect.runFork(program)
+ * Effect.runFork(program)
  * // BATCH [
  * // timestamp=... level=INFO fiber=#0 message=one
  * // timestamp=... level=INFO fiber=#0 message=two
@@ -265,7 +265,7 @@ export const batched: {
    *   yield* Effect.log("three")
    * }).pipe(Effect.provide(LoggerLive))
    *
-   * // Effect.runFork(program)
+   * Effect.runFork(program)
    * // BATCH [
    * // timestamp=... level=INFO fiber=#0 message=one
    * // timestamp=... level=INFO fiber=#0 message=two
@@ -301,7 +301,7 @@ export const batched: {
    *   yield* Effect.log("three")
    * }).pipe(Effect.provide(LoggerLive))
    *
-   * // Effect.runFork(program)
+   * Effect.runFork(program)
    * // BATCH [
    * // timestamp=... level=INFO fiber=#0 message=one
    * // timestamp=... level=INFO fiber=#0 message=two
@@ -465,7 +465,7 @@ export const test: {
  *
  * const program = Effect.logDebug("message1").pipe(Logger.withMinimumLogLevel(LogLevel.Debug))
  *
- * // Effect.runFork(program)
+ * Effect.runFork(program)
  * // timestamp=... level=DEBUG fiber=#0 message=message1
  * ```
  *
@@ -483,7 +483,7 @@ export const withMinimumLogLevel: {
    *
    * const program = Effect.logDebug("message1").pipe(Logger.withMinimumLogLevel(LogLevel.Debug))
    *
-   * // Effect.runFork(program)
+   * Effect.runFork(program)
    * // timestamp=... level=DEBUG fiber=#0 message=message1
    * ```
    *
@@ -501,7 +501,7 @@ export const withMinimumLogLevel: {
    *
    * const program = Effect.logDebug("message1").pipe(Logger.withMinimumLogLevel(LogLevel.Debug))
    *
-   * // Effect.runFork(program)
+   * Effect.runFork(program)
    * // timestamp=... level=DEBUG fiber=#0 message=message1
    * ```
    *
@@ -597,7 +597,7 @@ export const defaultLogger: Logger<unknown, void> = fiberRuntime.defaultLogger
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.json)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.json)))
  * // {"message":["message1","message2"],"logLevel":"INFO","timestamp":"...","annotations":{"key2":"value2","key1":"value1"},"spans":{"myspan":0},"fiberId":"#0"}
  * ```
  *
@@ -619,7 +619,7 @@ export const jsonLogger: Logger<unknown, string> = internal.jsonLogger
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.logFmt)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.logFmt)))
  * // timestamp=... level=INFO fiber=#0 message=message1 message=message2 myspan=0ms key2=value2 key1=value1
  * ```
  *
@@ -649,7 +649,7 @@ export const stringLogger: Logger<unknown, string> = internal.stringLogger
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.pretty)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.pretty)))
  * //         green --v                      v-- bold and cyan
  * // [07:51:54.434] INFO (#0) myspan=1ms: message1
  * //   message2
@@ -692,7 +692,7 @@ export const prettyLoggerDefault: Logger<unknown, void> = internal.prettyLoggerD
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.structured)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.structured)))
  * // {
  * //   message: [ 'message1', 'message2' ],
  * //   logLevel: 'INFO',
@@ -739,7 +739,7 @@ export const tracerLogger: Logger<unknown, void> = fiberRuntime.tracerLogger
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.json)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.json)))
  * // {"message":["message1","message2"],"logLevel":"INFO","timestamp":"...","annotations":{"key2":"value2","key1":"value1"},"spans":{"myspan":0},"fiberId":"#0"}
  * ```
  *
@@ -761,7 +761,7 @@ export const json: Layer.Layer<never> = replace(fiberRuntime.defaultLogger, fibe
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.logFmt)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.logFmt)))
  * // timestamp=... level=INFO fiber=#0 message=message1 message=message2 myspan=0ms key2=value2 key1=value1
  * ```
  *
@@ -785,7 +785,7 @@ export const logFmt: Layer.Layer<never> = replace(fiberRuntime.defaultLogger, fi
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.pretty)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.pretty)))
  * //         green --v                      v-- bold and cyan
  * // [07:51:54.434] INFO (#0) myspan=1ms: message1
  * //   message2
@@ -813,7 +813,7 @@ export const pretty: Layer.Layer<never> = replace(fiberRuntime.defaultLogger, fi
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.structured)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.structured)))
  * // {
  * //   message: [ 'message1', 'message2' ],
  * //   logLevel: 'INFO',
@@ -845,7 +845,7 @@ export const structured: Layer.Layer<never> = replace(fiberRuntime.defaultLogger
  * })
  *
  * // Logging disabled using a layer
- * // Effect.runFork(program.pipe(Effect.provide(Logger.minimumLogLevel(LogLevel.None))))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.minimumLogLevel(LogLevel.None))))
  * // task done
  * ```
  *

package/src/Match.ts

@@ -160,11 +160,9 @@ export interface Not {
  * created, you can use pattern-matching functions like {@link when} to define
  * how different values should be processed.
  *
- * @see {@link value} for creating a matcher from a specific value.
+ * **Example** (Matching Numbers and Strings)
  *
- * @example
  * ```ts
- * // Title: Matching Numbers and Strings
  * import { Match } from "effect"
  *
  * // Create a matcher for values that are either strings or numbers
@@ -187,6 +185,8 @@ export interface Not {
  * // Output: "string: hello"
  * ```
  *
+ * @see {@link value} for creating a matcher from a specific value.
+ *
  * @category Creating a matcher
  * @since 1.0.0
  */
@@ -205,11 +205,9 @@ export const type: <I>() => Matcher<I, Types.Without<never>, I, never, never> =
  * Once the matcher is created, you can use pattern-matching functions like
  * {@link when} to define how different cases should be handled.
  *
- * @see {@link type} for creating a matcher from a specific type.
+ * **Example** (Matching an Object by Property)
  *
- * @example
  * ```ts
- * // Title: Matching an Object by Property
  * import { Match } from "effect"
  *
  * const input = { name: "John", age: 30 }
@@ -229,6 +227,8 @@ export const type: <I>() => Matcher<I, Types.Without<never>, I, never, never> =
  * // Output: "John is 30 years old"
  * ```
  *
+ * @see {@link type} for creating a matcher from a specific type.
+ *
  * @category Creating a matcher
  * @since 1.0.0
  */
@@ -277,9 +277,9 @@ export const typeTags: <I>() => <
  * **Important:** This function must be the first step in the matcher pipeline.
  * If used later, TypeScript will not enforce type consistency correctly.
  *
- * @example
+ * **Example** (Validating Return Type Consistency)
+ *
  * ```ts
- * // Title: Validating Return Type Consistency
  * import { Match } from "effect"
  *
  * const match = Match.type<{ a: number } | { b: string }>().pipe(
@@ -315,14 +315,9 @@ export const withReturnType: <Ret>() => <I, F, R, A, Pr, _>(
  * specific values or apply logical conditions to determine a match. It works
  * well with structured objects and primitive types.
  *
- * @see {@link whenOr} Use this when multiple patterns should match in a single
- * condition.
- * @see {@link whenAnd} Use this when a value must match all provided patterns.
- * @see {@link orElse} Provides a fallback when no patterns match.
+ * **Example** (Matching with Values and Predicates)
  *
- * @example
  * ```ts
- * // Title: Matching with Values and Predicates
  * import { Match } from "effect"
  *
  * // Create a matcher for objects with an "age" property
@@ -345,6 +340,11 @@ export const withReturnType: <Ret>() => <I, F, R, A, Pr, _>(
  * // Output: "4 is too young"
  * ```
  *
+ * @see {@link whenOr} Use this when multiple patterns should match in a single
+ * condition.
+ * @see {@link whenAnd} Use this when a value must match all provided patterns.
+ * @see {@link orElse} Provides a fallback when no patterns match.
+ *
  * @category Defining patterns
  * @since 1.0.0
  */
@@ -684,9 +684,9 @@ export const discriminatorsExhaustive: <D extends string>(
  * of naming the tag field as `"_tag"`. Ensure that your discriminated unions
  * follow this naming convention for proper functionality.
  *
- * @example
+ * **Example** (Matching a Discriminated Union by Tag)
+ *
  * ```ts
- * // Title: Matching a Discriminated Union by Tag
  * import { Match } from "effect"
  *
  * type Event =
@@ -883,9 +883,9 @@ export const tagsExhaustive: <
  * Any excluded value will bypass the provided function and continue matching
  * through other cases.
  *
- * @example
+ * **Example** (Ignoring a Specific Value)
+ *
  * ```ts
- * // Title: Ignoring a Specific Value
  * import { Match } from "effect"
  *
  * // Create a matcher for string or number values
@@ -1065,9 +1065,9 @@ export const instanceOfUnsafe: <A extends abstract new(...args: any) => any>(
  * `default` clause in a `switch` statement or the final `else` in an `if-else`
  * chain.
  *
- * @example
+ * **Example** (Providing a Default Value When No Patterns Match)
+ *
  * ```ts
- * // Title: Providing a Default Value When No Patterns Match
  * import { Match } from "effect"
  *
  * // Create a matcher for string or number values
@@ -1130,9 +1130,9 @@ export const orElseAbsurd: <I, R, RA, A, Pr, Ret>(
  * unmatched case should be explicitly handled rather than returning a default
  * value or throwing an error.
  *
- * @example
+ * **Example** (Extracting a User Role with `Match.either`)
+ *
  * ```ts
- * // Title: Extracting a User Role with Either
  * import { Match } from "effect"
  *
  * type User = { readonly role: "admin" | "editor" | "viewer" }
@@ -1171,9 +1171,9 @@ export const either: <I, F, R, A, Pr, Ret>(
  * handled explicitly rather than throwing an error or returning a default
  * value.
  *
- * @example
+ * **Example** (Extracting a User Role with `Match.option`)
+ *
  * ```ts
- * // Title: Extracting a User Role with Option
  * import { Match } from "effect"
  *
  * type User = { readonly role: "admin" | "editor" | "viewer" }
@@ -1205,9 +1205,9 @@ export const option: <I, F, R, A, Pr, Ret>(
  * TypeScript will produce a type error. This is particularly useful when
  * working with unions, as it helps prevent unintended gaps in pattern matching.
  *
- * @example
+ * **Example** (Ensuring All Cases Are Covered)
+ *
  * ```ts
- * // Title: Ensuring All Cases Are Covered
  * import { Match } from "effect"
  *
  * // Create a matcher for string or number values