effect 4.0.0-beta.73 → 4.0.0-beta.75

package/src/Logger.ts

@@ -171,7 +171,7 @@ export interface Logger<in Message, out Output> extends Pipeable {
  * )
  * ```
  *
- * @category models
+ * @category options
  * @since 2.0.0
  */
 export interface Options<out Message> {
@@ -245,8 +245,8 @@ export const CurrentLoggers: Context.Reference<ReadonlySet<Logger<unknown, any>>
  *
  * **When to use**
  *
- * Use to keep stdout reserved for protocol messages or data output while still
- * allowing Effect runtime logs to be emitted.
+ * Use to route built-in logger output to stderr while keeping stdout reserved
+ * for protocol messages or data output.
  *
  * **Details**
  *
@@ -267,8 +267,8 @@ export const LogToStderr: Context.Reference<boolean> = effect.LogToStderr
  *
  * **When to use**
  *
- * Use when this allows you to modify, enhance, or completely change the output format
- * of an existing logger without recreating the entire logging logic.
+ * Use when an existing logger's output should be transformed without recreating the
+ * logging logic.
  *
  * **Example** (Transforming logger output)
  *
@@ -295,7 +295,7 @@ export const LogToStderr: Context.Reference<boolean> = effect.LogToStderr
  * )
  * ```
  *
- * @category utils
+ * @category mapping
  * @since 2.0.0
  */
 export const map = dual<
@@ -304,8 +304,8 @@ export const map = dual<
    *
    * **When to use**
    *
-   * Use when this allows you to modify, enhance, or completely change the output format
-   * of an existing logger without recreating the entire logging logic.
+   * Use when an existing logger's output should be transformed without recreating the
+   * logging logic.
    *
    * **Example** (Transforming logger output)
    *
@@ -332,7 +332,7 @@ export const map = dual<
    * )
    * ```
    *
-   * @category utils
+   * @category mapping
    * @since 2.0.0
    */
   <Output, Output2>(f: (output: Output) => Output2) => <Message>(
@@ -343,8 +343,8 @@ export const map = dual<
    *
    * **When to use**
    *
-   * Use when this allows you to modify, enhance, or completely change the output format
-   * of an existing logger without recreating the entire logging logic.
+   * Use when an existing logger's output should be transformed without recreating the
+   * logging logic.
    *
    * **Example** (Transforming logger output)
    *
@@ -371,7 +371,7 @@ export const map = dual<
    * )
    * ```
    *
-   * @category utils
+   * @category mapping
    * @since 2.0.0
    */
   <Message, Output, Output2>(self: Logger<Message, Output>, f: (output: Output) => Output2) => Logger<Message, Output2>
@@ -383,8 +383,8 @@ export const map = dual<
  *
  * **When to use**
  *
- * Use when this is useful for taking any logger that produces string or object output
- * and routing it to the console for development or debugging purposes.
+ * Use when a logger's string or object output should be routed to `console.log` for
+ * development or debugging.
  *
  * **Example** (Writing logger output with console.log)
  *
@@ -404,7 +404,7 @@ export const map = dual<
  * )
  * ```
  *
- * @category utils
+ * @category logging
  * @since 2.0.0
  */
 export const withConsoleLog = <Message, Output>(
@@ -420,8 +420,8 @@ export const withConsoleLog = <Message, Output>(
  *
  * **When to use**
  *
- * Use when this is particularly useful for error logging where you want to ensure
- * log messages appear in the error stream (stderr) rather than standard output.
+ * Use when logger output should be routed to `console.error`, such as error logs that
+ * should appear on stderr instead of stdout.
  *
  * **Example** (Writing logger output with console.error)
  *
@@ -441,7 +441,7 @@ export const withConsoleLog = <Message, Output>(
  * )
  * ```
  *
- * @category utils
+ * @category logging
  * @since 2.0.0
  */
 export const withConsoleError = <Message, Output>(
@@ -460,12 +460,9 @@ export const withConsoleError = <Message, Output>(
  * Will use the appropriate console method (i.e. `console.log`, `console.error`,
  * etc.) based upon the current `LogLevel`.
  *
- * - `Debug` -> `console.debug`
- * - `Info` -> `console.info`
- * - `Trace` -> `console.trace`
- * - `Warn` -> `console.warn`
- * - `Error` and `Fatal` -> `console.error`
- * - Others -> `console.log`
+ * `Debug` uses `console.debug`, `Info` uses `console.info`, `Trace` uses
+ * `console.trace`, `Warn` uses `console.warn`, `Error` and `Fatal` use
+ * `console.error`, and all other levels use `console.log`.
  *
  * **Example** (Writing logs with level-based console methods)
  *
@@ -488,7 +485,7 @@ export const withConsoleError = <Message, Output>(
  * )
  * ```
  *
- * @category utils
+ * @category logging
  * @since 3.8.0
  */
 export const withLeveledConsole = <Message, Output>(

package/src/ManagedRuntime.ts

@@ -94,7 +94,7 @@ export declare namespace ManagedRuntime {
    * Use to derive the service requirements provided by an existing
    * `ManagedRuntime` type.
    *
-   * @category type-level
+   * @category utility types
    * @since 3.4.0
    */
   export type Services<T extends ManagedRuntime<never, any>> = [T] extends [ManagedRuntime<infer R, infer _E>] ? R
@@ -107,7 +107,7 @@ export declare namespace ManagedRuntime {
    * Use to derive the layer construction error type from an existing
    * `ManagedRuntime` type.
    *
-   * @category type-level
+   * @category utility types
    * @since 3.4.0
    */
   export type Error<T extends ManagedRuntime<never, any>> = [T] extends [ManagedRuntime<infer _R, infer E>] ? E : never

package/src/Match.ts

@@ -309,7 +309,7 @@ export interface Not {
  *
  * @see {@link value} for creating a matcher from a specific value.
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export const type: <I>() => Matcher<I, Types.Without<never>, I, never, never> = internal.type
@@ -355,7 +355,7 @@ export const type: <I>() => Matcher<I, Types.Without<never>, I, never, never> =
  *
  * @see {@link type} for creating a matcher from a specific type.
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export const value: <const I>(
@@ -388,7 +388,7 @@ export const value: <const I>(
  * console.log(message) // "Success: Hello"
  * ```
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export const valueTags: {
@@ -418,7 +418,7 @@ export const valueTags: {
    * console.log(message) // "Success: Hello"
    * ```
    *
-   * @category Creating a matcher
+   * @category constructors
    * @since 4.0.0
    */
   <
@@ -453,7 +453,7 @@ export const valueTags: {
    * console.log(message) // "Success: Hello"
    * ```
    *
-   * @category Creating a matcher
+   * @category constructors
    * @since 4.0.0
    */
   <
@@ -507,7 +507,7 @@ export const valueTags: {
  * // Output: { type: "pending" }
  * ```
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export const typeTags: {
@@ -554,7 +554,7 @@ export const typeTags: {
    * // Output: { type: "pending" }
    * ```
    *
-   * @category Creating a matcher
+   * @category constructors
    * @since 4.0.0
    */
   <I, Ret>(): <
@@ -609,7 +609,7 @@ export const typeTags: {
    * // Output: { type: "pending" }
    * ```
    *
-   * @category Creating a matcher
+   * @category constructors
    * @since 4.0.0
    */
   <I>(): <
@@ -652,7 +652,7 @@ export const typeTags: {
  * )
  * ```
  *
- * @category utils
+ * @category utility types
  * @since 4.0.0
  */
 export const withReturnType: <Ret>() => <I, F, R, A, Pr, _>(
@@ -1381,7 +1381,7 @@ export const not: <
  *
  * @see {@link string} for matching any string
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const nonEmptyString: SafeRefinement<string, never> = internal.nonEmptyString
@@ -1427,7 +1427,7 @@ export const nonEmptyString: SafeRefinement<string, never> = internal.nonEmptySt
  * // Output: "Unknown status: pending"
  * ```
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const is: <
@@ -1553,7 +1553,7 @@ export const number: Predicate.Refinement<unknown, number> = Predicate.isNumber
  * @see {@link defined} for matching only non-nullish values
  * @see {@link orElse} for providing a fallback after earlier cases
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const any: SafeRefinement<unknown, any> = internal.any
@@ -1602,7 +1602,7 @@ export const any: SafeRefinement<unknown, any> = internal.any
  *
  * @see {@link any} for matching every value without excluding nullish inputs
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const defined: <A>(u: A) => u is A & {} = internal.defined
@@ -1665,7 +1665,7 @@ export {
    * @see {@link defined} for matching non-nullish values
    * @see {@link is} for matching literal values
    *
-   * @category Predicates
+   * @category predicates
    * @since 4.0.0
    */
   _undefined as undefined
@@ -1678,7 +1678,7 @@ export {
    *
    * **When to use**
    *
-   * Use when a match branch should handle only the literal `null` value.
+   * Use to handle only the `null` literal in a match branch.
    *
    * **Details**
    *
@@ -1688,7 +1688,7 @@ export {
    * @see {@link defined} for matching non-nullish values
    * @see {@link is} for matching literal values
    *
-   * @category Predicates
+   * @category predicates
    * @since 4.0.0
    */
   _null as null
@@ -1914,7 +1914,7 @@ export const record: Predicate.Refinement<unknown, { [x: PropertyKey]: unknown }
  * @see {@link instanceOfUnsafe} for constructor matching without the same type-safety guarantee
  * @see {@link record} for matching broad non-null, non-array objects
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const instanceOf: <A extends abstract new(...args: any) => any>(
@@ -1926,7 +1926,7 @@ export const instanceOf: <A extends abstract new(...args: any) => any>(
  *
  * **When to use**
  *
- * Use when constructor matching needs the unsafe refinement type.
+ * Use when you need constructor matching to use the unsafe refinement type.
  *
  * **Details**
  *
@@ -2003,7 +2003,7 @@ export const instanceOfUnsafe: <A extends abstract new(...args: any) => any>(
  * @see {@link result} for returning unmatched input as a `Result` failure
  * @see {@link orElseAbsurd} for finalizing when unmatched input should be impossible
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const orElse: <RA, Ret, F extends (_: RA) => Ret>(
@@ -2096,7 +2096,7 @@ export const orElseAbsurd: <I, R, RA, A, Pr, Ret>(
  * // Output: { _id: 'Result', _tag: 'Err', err: { role: 'viewer' } }
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const result: <I, F, R, A, Pr, Ret>(
@@ -2145,7 +2145,7 @@ export const result: <I, F, R, A, Pr, Ret>(
  * @see {@link result} for preserving unmatched input as a `Result` failure
  * @see {@link orElse} for replacing unmatched input with a fallback value
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const option: <I, F, R, A, Pr, Ret>(
@@ -2181,7 +2181,7 @@ export const option: <I, F, R, A, Pr, Ret>(
  * )
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const exhaustive: <I, F, A, Pr, Ret>(