effect 4.0.0-beta.66 → 4.0.0-beta.67

package/src/Predicate.ts

@@ -161,8 +161,8 @@ export interface Refinement<in A, out B extends A> {
  *
  * See also: {@link Predicate}, {@link Refinement}
  *
- * @since 3.6.0
  * @category type-level
+ * @since 3.6.0
  */
 export declare namespace Predicate {
   /**
@@ -187,8 +187,8 @@ export declare namespace Predicate {
    *
    * See also: {@link Predicate.Any}, {@link Refinement.In}
    *
-   * @since 3.6.0
    * @category type-level
+   * @since 3.6.0
    */
   export type In<T extends Any> = [T] extends [Predicate<infer _A>] ? _A : never
 
@@ -211,8 +211,8 @@ export declare namespace Predicate {
    *
    * See also: {@link Predicate.In}
    *
-   * @since 3.6.0
    * @category type-level
+   * @since 3.6.0
    */
   export type Any = Predicate<any>
 }
@@ -240,8 +240,8 @@ export declare namespace Predicate {
  *
  * See also: {@link Refinement}, {@link Predicate}
  *
- * @since 3.6.0
  * @category type-level
+ * @since 3.6.0
  */
 export declare namespace Refinement {
   /**
@@ -265,8 +265,8 @@ export declare namespace Refinement {
    *
    * See also: {@link Refinement.Out}, {@link Predicate.In}
    *
-   * @since 3.6.0
    * @category type-level
+   * @since 3.6.0
    */
 
   export type In<T extends Any> = [T] extends [Refinement<infer _A, infer _>] ? _A : never
@@ -292,8 +292,8 @@ export declare namespace Refinement {
    *
    * See also: {@link Refinement.In}
    *
-   * @since 3.6.0
    * @category type-level
+   * @since 3.6.0
    */
   export type Out<T extends Any> = [T] extends [Refinement<infer _, infer _B>] ? _B : never
 
@@ -316,8 +316,8 @@ export declare namespace Refinement {
    *
    * See also: {@link Refinement.In}, {@link Refinement.Out}
    *
-   * @since 3.6.0
    * @category type-level
+   * @since 3.6.0
    */
   export type Any = Refinement<any, any>
 }
@@ -1161,14 +1161,11 @@ export function isObjectOrArray(input: unknown): input is { [x: PropertyKey]: un
 }
 
 /**
- * Checks whether a value is a plain object (not an array, not `null`).
+ * Checks whether a value is a non-null object value that is not an array.
  *
- * When to use:
- * - You need to accept objects but exclude arrays.
- *
- * Behavior:
- * - Pure; does not mutate input.
- * - Uses `typeof input === "object" && input !== null && !Array.isArray(input)`.
+ * This is a structural runtime check using `typeof input === "object"`, so it
+ * also accepts object instances such as `Date`, `Map`, class instances, and
+ * typed arrays. It excludes `null` and arrays.
  *
  * **Example** (Guard object)
  *
@@ -1189,14 +1186,12 @@ export function isObject(input: unknown): input is { [x: PropertyKey]: unknown }
 }
 
 /**
- * Checks whether a value is a readonly object.
- *
- * When to use:
- * - You need a guard for object-like values and do not care about mutability.
+ * Checks whether a value is a non-null, non-array object and narrows it to a
+ * readonly indexable object type.
  *
- * Behavior:
- * - Pure; does not mutate input.
- * - Delegates to {@link isObject}.
+ * Readonly-ness is a TypeScript type-level view; it is not observable at
+ * runtime. This delegates to `isObject`, so class instances and built-in object
+ * instances are accepted.
  *
  * **Example** (Readonly object)
  *

package/src/PrimaryKey.ts

@@ -25,7 +25,8 @@ export const symbol = "~effect/interfaces/PrimaryKey"
  * Objects implementing this interface must provide a method that returns
  * a unique string identifier.
  *
- * @example
+ * **Example** (Implementing a primary key)
+ *
  * ```ts
  * import { PrimaryKey } from "effect"
  *
@@ -49,6 +50,11 @@ export interface PrimaryKey {
 }
 
 /**
+ * Checks whether a value implements the `PrimaryKey` protocol.
+ *
+ * This is a structural guard for the `PrimaryKey.symbol` property. It does not
+ * call the method or verify that it returns a string.
+ *
  * @category models
  * @since 2.0.0
  */
@@ -57,7 +63,8 @@ export const isPrimaryKey = (u: unknown): u is PrimaryKey => hasProperty(u, symb
 /**
  * Extracts the string value from a `PrimaryKey`.
  *
- * @example
+ * **Example** (Reading primary key values)
+ *
  * ```ts
  * import { PrimaryKey } from "effect"
  *