effect 4.0.0-beta.67 → 4.0.0-beta.68

package/src/Effectable.ts

@@ -74,8 +74,8 @@ const Base: new<A, E, R>() => Effect.Effect<A, E, R> = (() => {
 /**
  * An abstract class that can be extended to create an `Effect`.
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export abstract class Class<A, E = never, R = never> extends Base<A, E, R> {
   abstract override: Effect.Effect<A, E, R>

package/src/Encoding.ts

@@ -85,7 +85,7 @@ export const isEncodingError = (u: unknown): u is EncodingError => hasProperty(u
  * ```
  *
  * @category encoding
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const encodeBase64: (input: Uint8Array | string) => string = (input) =>
   typeof input === "string" ? base64EncodeUint8Array(encoder.encode(input)) : base64EncodeUint8Array(input)
@@ -108,7 +108,7 @@ export const encodeBase64: (input: Uint8Array | string) => string = (input) =>
  * ```
  *
  * @category decoding
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const decodeBase64 = (str: string): Result.Result<Uint8Array, EncodingError> => {
   const stripped = stripCrlf(str)
@@ -181,7 +181,7 @@ export const decodeBase64 = (str: string): Result.Result<Uint8Array, EncodingErr
  * ```
  *
  * @category decoding
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const decodeBase64String = (str: string) => Result.map(decodeBase64(str), (_) => decoder.decode(_))
 
@@ -205,7 +205,7 @@ export const decodeBase64String = (str: string) => Result.map(decodeBase64(str),
  * ```
  *
  * @category encoding
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const encodeBase64Url: (input: Uint8Array | string) => string = (input) =>
   typeof input === "string" ? base64UrlEncodeUint8Array(encoder.encode(input)) : base64UrlEncodeUint8Array(input)
@@ -230,7 +230,7 @@ export const encodeBase64Url: (input: Uint8Array | string) => string = (input) =
  * ```
  *
  * @category decoding
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const decodeBase64Url = (str: string): Result.Result<Uint8Array, EncodingError> => {
   const stripped = stripCrlf(str)
@@ -283,7 +283,7 @@ export const decodeBase64Url = (str: string): Result.Result<Uint8Array, Encoding
  * ```
  *
  * @category decoding
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const decodeBase64UrlString = (str: string) => Result.map(decodeBase64Url(str), (_) => decoder.decode(_))
 
@@ -308,7 +308,7 @@ export const decodeBase64UrlString = (str: string) => Result.map(decodeBase64Url
  * ```
  *
  * @category encoding
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const encodeHex: (input: Uint8Array | string) => string = (input) =>
   typeof input === "string" ? hexEncodeUint8Array(encoder.encode(input)) : hexEncodeUint8Array(input)
@@ -332,7 +332,7 @@ export const encodeHex: (input: Uint8Array | string) => string = (input) =>
  * ```
  *
  * @category decoding
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const decodeHex = (str: string): Result.Result<Uint8Array, EncodingError> => {
   const bytes = new TextEncoder().encode(str)
@@ -387,7 +387,7 @@ export const decodeHex = (str: string): Result.Result<Uint8Array, EncodingError>
  * ```
  *
  * @category decoding
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const decodeHexString = (str: string) => Result.map(decodeHex(str), (_) => decoder.decode(_))
 

package/src/Equal.ts

@@ -109,6 +109,7 @@ import { hasProperty } from "./Predicate.ts"
  * @see {@link Equal} — the interface that uses this symbol
  * @see {@link isEqual} — type guard for `Equal` implementors
  *
+ * @category symbols
  * @since 2.0.0
  */
 export const symbol = "~effect/interfaces/Equal"
@@ -519,7 +520,7 @@ export const isEqual = (u: unknown): u is Equal => hasProperty(u, symbol)
  * @see {@link equals} — the underlying comparison function
  *
  * @category instances
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const asEquivalence: <A>() => Equivalence<A> = () => equals
 
@@ -562,7 +563,7 @@ export const asEquivalence: <A>() => Equivalence<A> = () => equals
  * @see {@link equals} — the comparison function affected by this opt-out
  *
  * @category utility
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const byReference = <T extends object>(obj: T): T => byReferenceUnsafe(new Proxy(obj, {}))
 
@@ -603,7 +604,7 @@ export const byReference = <T extends object>(obj: T): T => byReferenceUnsafe(ne
  * @see {@link equals} — the comparison function affected by this opt-out
  *
  * @category utility
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const byReferenceUnsafe = <T extends object>(obj: T): T => {
   byReferenceInstances.add(obj)

package/src/Equivalence.ts

@@ -117,11 +117,10 @@ export type Equivalence<in A> = (self: A, that: A) => boolean
  * **Example** (Type-level usage)
  *
  * ```ts
- * import type { Equivalence } from "effect"
- * import type { Kind } from "effect/HKT"
+ * import type { Equivalence, HKT } from "effect"
  *
  * // Used internally for type-level computations
- * type NumberEquivalence = Kind<
+ * type NumberEquivalence = HKT.Kind<
  *   Equivalence.EquivalenceTypeLambda,
  *   never,
  *   never,
@@ -1060,7 +1059,7 @@ export function Record<A>(value: Equivalence<A>): Equivalence<Record<PropertyKey
  * - {@link combineAll} - Combine multiple equivalences
  * - {@link Reducer} - Reducer type for collection operations
  *
- * @category utilities
+ * @category utils
  * @since 4.0.0
  */
 export function makeReducer<A>() {
@@ -1111,7 +1110,7 @@ export function makeReducer<A>() {
  * See also: {@link Number}, {@link mapInput}, {@link strictEqual}
  *
  * @category instances
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const Date: Equivalence<Date> = mapInput(
   Number,

package/src/ErrorReporter.ts

@@ -87,7 +87,7 @@ export const TypeId: TypeId = "~effect/ErrorReporter"
  * modules. Use {@link make} to create a reporter — it handles deduplication
  * and per-error annotation extraction automatically.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface ErrorReporter {
@@ -120,7 +120,7 @@ export interface ErrorReporter {
  * )
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make = (
@@ -169,7 +169,7 @@ export const make = (
  * reference directly only when you need low-level control (e.g. reading the
  * current reporters or swapping them inside a `FiberRef`).
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export const CurrentErrorReporters: Context.Reference<ReadonlySet<ErrorReporter>> = references.CurrentErrorReporters
@@ -215,7 +215,7 @@ export const CurrentErrorReporters: Context.Reference<ReadonlySet<ErrorReporter>
  * )
  * ```
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = <
@@ -284,7 +284,7 @@ export const report = <E>(cause: Cause.Cause<E>): Effect.Effect<void> =>
  * The global `Error` interface is augmented with `Reportable`, so these
  * properties are available on `Error` instances at the type level.
  *
- * @category Annotations
+ * @category annotations
  * @since 4.0.0
  */
 export interface Reportable {
@@ -305,7 +305,7 @@ declare global {
  * from being forwarded to reporters. This is useful for expected failures such
  * as HTTP 404 responses.
  *
- * @category Annotations
+ * @category annotations
  * @since 4.0.0
  */
 export type ignore = "~effect/ErrorReporter/ignore"
@@ -328,7 +328,7 @@ export type ignore = "~effect/ErrorReporter/ignore"
  * }
  * ```
  *
- * @category Annotations
+ * @category annotations
  * @since 4.0.0
  */
 export const ignore: ignore = "~effect/ErrorReporter/ignore"
@@ -337,7 +337,7 @@ export const ignore: ignore = "~effect/ErrorReporter/ignore"
  * Returns `true` if the given value has the `ErrorReporter.ignore` annotation
  * set to `true`.
  *
- * @category Annotations
+ * @category annotations
  * @since 4.0.0
  */
 export const isIgnored = (u: unknown): boolean =>
@@ -349,7 +349,7 @@ export const isIgnored = (u: unknown): boolean =>
  * When set to a valid `LogLevel.Severity`, the reporter callback receives this
  * value as `severity`. Missing or invalid values fall back to `"Info"`.
  *
- * @category Annotations
+ * @category annotations
  * @since 4.0.0
  */
 export type severity = "~effect/ErrorReporter/severity"
@@ -370,7 +370,7 @@ export type severity = "~effect/ErrorReporter/severity"
  * }
  * ```
  *
- * @category Annotations
+ * @category annotations
  * @since 4.0.0
  */
 export const severity: severity = "~effect/ErrorReporter/severity"
@@ -379,7 +379,7 @@ export const severity: severity = "~effect/ErrorReporter/severity"
  * Reads the `ErrorReporter.severity` annotation from an error object,
  * falling back to `"Info"` when the annotation is unset or invalid.
  *
- * @category Annotations
+ * @category annotations
  * @since 4.0.0
  */
 export const getSeverity = (error: object): Severity => {
@@ -397,7 +397,7 @@ export const getSeverity = (error: object): Severity => {
  * include contextual information such as user IDs, request IDs, or other
  * domain-specific debugging data.
  *
- * @category Annotations
+ * @category annotations
  * @since 4.0.0
  */
 export type attributes = "~effect/ErrorReporter/attributes"
@@ -423,7 +423,7 @@ export type attributes = "~effect/ErrorReporter/attributes"
  * }
  * ```
  *
- * @category Annotations
+ * @category annotations
  * @since 4.0.0
  */
 export const attributes: attributes = "~effect/ErrorReporter/attributes"
@@ -432,7 +432,7 @@ export const attributes: attributes = "~effect/ErrorReporter/attributes"
  * Reads the `ErrorReporter.attributes` annotation from an error object,
  * returning an empty record when unset.
  *
- * @category Annotations
+ * @category annotations
  * @since 4.0.0
  */
 export const getAttributes = (error: object): ReadonlyRecord<string, unknown> => {

package/src/ExecutionPlan.ts

@@ -53,7 +53,7 @@ import type * as Schedule from "./Schedule.ts"
  * String literal type used as the runtime type identifier for `ExecutionPlan`
  * values.
  *
- * @category Type IDs
+ * @category type IDs
  * @since 3.16.0
  */
 export type TypeId = "~effect/ExecutionPlan"
@@ -62,7 +62,7 @@ export type TypeId = "~effect/ExecutionPlan"
  * Runtime type identifier attached to `ExecutionPlan` values and used by
  * `isExecutionPlan`.
  *
- * @category Type IDs
+ * @category type IDs
  * @since 3.16.0
  */
 export const TypeId: TypeId = "~effect/ExecutionPlan"
@@ -72,7 +72,7 @@ export const TypeId: TypeId = "~effect/ExecutionPlan"
  *
  * This is a type guard that checks for the `ExecutionPlan.TypeId` marker.
  *
- * @category Guards
+ * @category guards
  * @since 3.16.0
  */
 export const isExecutionPlan = (u: unknown): u is ExecutionPlan<any> => Predicate.hasProperty(u, TypeId)
@@ -80,9 +80,11 @@ export const isExecutionPlan = (u: unknown): u is ExecutionPlan<any> => Predicat
 /**
  * A `ExecutionPlan` can be used with `Effect.withExecutionPlan` or `Stream.withExecutionPlan`, allowing you to provide different resources for each step of execution until the effect succeeds or the plan is exhausted.
  *
+ * **Example** (Defining fallback execution steps)
+ *
  * ```ts
- * import type { Layer } from "effect"
  * import { Effect, ExecutionPlan, Schedule } from "effect"
+ * import type { Layer } from "effect"
  * import type { LanguageModel } from "effect/unstable/ai"
  *
  * declare const layerBad: Layer.Layer<LanguageModel.LanguageModel>
@@ -117,7 +119,7 @@ export const isExecutionPlan = (u: unknown): u is ExecutionPlan<any> => Predicat
  * const withPlan: Effect.Effect<void> = Effect.withExecutionPlan(effect, ThePlan)
  * ```
  *
- * @category Models
+ * @category models
  * @since 3.16.0
  */
 export interface ExecutionPlan<
@@ -163,8 +165,8 @@ export interface ExecutionPlan<
  * from plan layers or predicates, and `requirements` tracks services needed to
  * build or run the plan.
  *
- * @category Models
- * @since 3.16.0
+ * @category models
+ * @since 4.0.0
  */
 export type ConfigBase = {
   provides: any
@@ -176,9 +178,11 @@ export type ConfigBase = {
 /**
  * Create an `ExecutionPlan`, which can be used with `Effect.withExecutionPlan` or `Stream.withExecutionPlan`, allowing you to provide different resources for each step of execution until the effect succeeds or the plan is exhausted.
  *
+ * **Example** (Creating an execution plan)
+ *
  * ```ts
- * import type { Layer } from "effect"
  * import { Effect, ExecutionPlan, Schedule } from "effect"
+ * import type { Layer } from "effect"
  * import type { LanguageModel } from "effect/unstable/ai"
  *
  * declare const layerBad: Layer.Layer<LanguageModel.LanguageModel>
@@ -213,7 +217,7 @@ export type ConfigBase = {
  * const withPlan: Effect.Effect<void> = Effect.withExecutionPlan(effect, ThePlan)
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 3.16.0
  */
 export const make = <const Steps extends NonEmptyReadonlyArray<make.Step>>(
@@ -261,6 +265,7 @@ export declare namespace make {
    * `while` predicate for retry decisions, or attach a `Schedule` for retry
    * timing.
    *
+   * @category models
    * @since 3.16.0
    */
   export type Step = {
@@ -274,6 +279,7 @@ export declare namespace make {
    * Computes the intersection of services provided by a list of execution-plan
    * steps.
    *
+   * @category utility types
    * @since 3.16.1
    */
   export type StepProvides<Steps extends ReadonlyArray<any>, Out = unknown> = Steps extends
@@ -290,6 +296,7 @@ export declare namespace make {
   /**
    * Computes the intersection of services provided by a list of execution plans.
    *
+   * @category utility types
    * @since 3.16.1
    */
   export type PlanProvides<Plans extends ReadonlyArray<any>, Out = unknown> = Plans extends
@@ -301,6 +308,7 @@ export declare namespace make {
    * Computes the input type consumed by the `while` predicates and schedules in
    * a list of execution-plan steps.
    *
+   * @category utility types
    * @since 3.16.0
    */
   export type StepInput<Steps extends ReadonlyArray<any>, Out = unknown> = Steps extends
@@ -317,6 +325,7 @@ export declare namespace make {
   /**
    * Computes the combined input type consumed by a list of execution plans.
    *
+   * @category utility types
    * @since 3.16.0
    */
   export type PlanInput<Plans extends ReadonlyArray<any>, Out = unknown> = Plans extends

package/src/Exit.ts

@@ -104,7 +104,6 @@ export type Exit<A, E = never> = Success<A, E> | Failure<A, E>
 /**
  * Namespace containing helper types shared by `Exit` values.
  *
- * @category models
  * @since 2.0.0
  */
 export declare namespace Exit {

package/src/Fiber.ts

@@ -165,7 +165,6 @@ export interface Fiber<out A, out E = never> extends Pipeable {
  * })
  * ```
  *
- * @category models
  * @since 2.0.0
  */
 export declare namespace Fiber {
@@ -624,7 +623,7 @@ export const isFiber = (
  * ```
  *
  * @category accessors
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const getCurrent: () => Fiber<any, any> | undefined = effect.getCurrentFiber
 

package/src/FiberHandle.ts

@@ -301,7 +301,7 @@ const isInternalInterruption = Filter.toPredicate(Filter.compose(
  * ```
  *
  * @category combinators
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const setUnsafe: {
   /**
@@ -327,7 +327,7 @@ export const setUnsafe: {
    * ```
    *
    * @category combinators
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A, E, XE extends E, XA extends A>(
     fiber: Fiber.Fiber<XA, XE>,
@@ -359,7 +359,7 @@ export const setUnsafe: {
    * ```
    *
    * @category combinators
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A, E, XE extends E, XA extends A>(
     self: FiberHandle<A, E>,
@@ -547,7 +547,7 @@ export const set: {
  * ```
  *
  * @category combinators
- * @since 2.0.0
+ * @since 4.0.0
  */
 export function getUnsafe<A, E>(self: FiberHandle<A, E>): Option.Option<Fiber.Fiber<A, E>> {
   return self.state._tag === "Closed" ? Option.none() : Option.fromUndefinedOr(self.state.fiber)
@@ -782,7 +782,7 @@ const runImpl = <A, E, R, XE extends E, XA extends A>(
  * **Example** (Capturing a runtime for fiber handles)
  *
  * ```ts
- * import { Effect, FiberHandle, Context } from "effect"
+ * import { Context, Effect, FiberHandle } from "effect"
  *
  * interface Users {
  *   readonly _: unique symbol

package/src/FiberMap.ts

@@ -328,7 +328,7 @@ const isInternalInterruption = Filter.toPredicate(Filter.compose(
  * ```
  *
  * @category combinators
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const setUnsafe: {
   /**
@@ -361,7 +361,7 @@ export const setUnsafe: {
    * ```
    *
    * @category combinators
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <K, A, E, XE extends E, XA extends A>(
     key: K,
@@ -401,7 +401,7 @@ export const setUnsafe: {
    * ```
    *
    * @category combinators
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <K, A, E, XE extends E, XA extends A>(
     self: FiberMap<K, A, E>,
@@ -614,7 +614,7 @@ export const set: {
  * ```
  *
  * @category combinators
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const getUnsafe: {
   /**
@@ -645,7 +645,7 @@ export const getUnsafe: {
    * ```
    *
    * @category combinators
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <K>(key: K): <A, E>(self: FiberMap<K, A, E>) => Option.Option<Fiber.Fiber<A, E>>
   /**
@@ -676,7 +676,7 @@ export const getUnsafe: {
    * ```
    *
    * @category combinators
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <K, A, E>(self: FiberMap<K, A, E>, key: K): Option.Option<Fiber.Fiber<A, E>>
 } = dual(
@@ -812,7 +812,7 @@ export const get: {
  * ```
  *
  * @category combinators
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const hasUnsafe: {
   /**
@@ -836,7 +836,7 @@ export const hasUnsafe: {
    * ```
    *
    * @category combinators
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <K>(key: K): <A, E>(self: FiberMap<K, A, E>) => boolean
   /**
@@ -860,7 +860,7 @@ export const hasUnsafe: {
    * ```
    *
    * @category combinators
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <K, A, E>(self: FiberMap<K, A, E>, key: K): boolean
 } = dual(
@@ -1309,7 +1309,7 @@ const runImpl = <K, A, E, R, XE extends E, XA extends A>(
  * **Example** (Capturing a runtime)
  *
  * ```ts
- * import { Effect, FiberMap, Context } from "effect"
+ * import { Context, Effect, FiberMap } from "effect"
  *
  * interface Users {
  *   readonly _: unique symbol

package/src/FiberSet.ts

@@ -299,7 +299,7 @@ const isInternalInterruption = Filter.toPredicate(Filter.compose(
  * ```
  *
  * @category combinators
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const addUnsafe: {
   /**
@@ -328,7 +328,7 @@ export const addUnsafe: {
    * ```
    *
    * @category combinators
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A, E, XE extends E, XA extends A>(
     fiber: Fiber.Fiber<XA, XE>,
@@ -362,7 +362,7 @@ export const addUnsafe: {
    * ```
    *
    * @category combinators
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A, E, XE extends E, XA extends A>(
     self: FiberSet<A, E>,
@@ -672,7 +672,7 @@ const runImpl = <A, E, R, XE extends E, XA extends A>(
  * **Example** (Capturing a runtime)
  *
  * ```ts
- * import { Effect, FiberSet, Context } from "effect"
+ * import { Context, Effect, FiberSet } from "effect"
  *
  * interface Users {
  *   readonly _: unique symbol

package/src/FileSystem.ts

@@ -87,7 +87,7 @@ const TypeId = "~effect/platform/FileSystem"
  * })
  * ```
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export interface FileSystem {
@@ -670,7 +670,7 @@ export const PiB = (n: number): Size => Size(BigInt(n) * bigintPiB)
  * })
  * ```
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export type OpenFlag =
@@ -733,7 +733,7 @@ export const FileSystem: Context.Service<FileSystem, FileSystem> = Context.Servi
  * default implementations for `exists`, `readFileString`, `stream`, `sink`, and
  * `writeFileString` methods based on the provided core methods.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const make = (
@@ -869,7 +869,7 @@ const notFound = (method: string, path: string) =>
  * )
  * ```
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const makeNoop = (fileSystem: Partial<FileSystem>): FileSystem =>
@@ -1077,7 +1077,6 @@ export interface File {
  * Namespace containing types associated with open file handles, including file
  * descriptors, entry kinds, and stat information.
  *
- * @category File
  * @since 4.0.0
  */
 export declare namespace File {
@@ -1178,7 +1177,7 @@ export declare namespace File {
  * File descriptors are integer handles that the operating system uses to identify
  * open files. This branded type ensures type safety when working with file descriptors.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const FileDescriptor = Brand.nominal<File.Descriptor>()
@@ -1189,7 +1188,7 @@ export const FileDescriptor = Brand.nominal<File.Descriptor>()
  * - `"start"` - Seek from the beginning of the file
  * - `"current"` - Seek from the current position
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export type SeekMode = "start" | "current"
@@ -1197,7 +1196,7 @@ export type SeekMode = "start" | "current"
 /**
  * Represents file system events that can be observed when watching files or directories.
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export type WatchEvent = WatchEvent.Create | WatchEvent.Update | WatchEvent.Remove
@@ -1205,7 +1204,6 @@ export type WatchEvent = WatchEvent.Create | WatchEvent.Update | WatchEvent.Remo
 /**
  * Namespace containing the concrete event shapes emitted by `FileSystem.watch`.
  *
- * @category model
  * @since 4.0.0
  */
 export declare namespace WatchEvent {
@@ -1215,7 +1213,7 @@ export declare namespace WatchEvent {
    * This event is triggered when a new file or directory is created
    * in the watched location.
    *
-   * @category model
+   * @category models
    * @since 4.0.0
    */
   export interface Create {
@@ -1229,7 +1227,7 @@ export declare namespace WatchEvent {
    * This event is triggered when an existing file or directory is
    * modified in the watched location.
    *
-   * @category model
+   * @category models
    * @since 4.0.0
    */
   export interface Update {
@@ -1243,7 +1241,7 @@ export declare namespace WatchEvent {
    * This event is triggered when a file or directory is deleted
    * from the watched location.
    *
-   * @category model
+   * @category models
    * @since 4.0.0
    */
   export interface Remove {