@xylabs/object-model 5.0.82 → 5.0.84

package/README.md

@@ -45,6 +45,8 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ***
 
+Configuration options for type check functions, with optional logging.
+
 ## Extended by
 
 - [`TypeCheckRequiredConfig`](#TypeCheckRequiredConfig)
@@ -64,6 +66,8 @@ optional log: boolean | Logger;
 
 ***
 
+Type check configuration that marks the value as optional, returning undefined on failure.
+
 ## Extends
 
 - [`TypeCheckConfig`](#TypeCheckConfig)
@@ -94,6 +98,8 @@ required: false;
 
 ***
 
+Type check configuration that marks the value as required, causing assertions on failure.
+
 ## Extends
 
 - [`TypeCheckConfig`](#TypeCheckConfig)
@@ -143,6 +149,8 @@ will result in a type that includes the universal set of field names
 type AsOptionalTypeFunction<T> = <TType>(value) => TType | undefined;
 ```
 
+A simplified type-narrowing function that returns T or undefined, without assertion support.
+
 ## Type Parameters
 
 ### T
@@ -182,6 +190,8 @@ type AsTypeFunction<T> = {
 };
 ```
 
+A type-narrowing function that attempts to cast a value to T, with optional assertion and configuration overloads.
+
 ## Type Parameters
 
 ### T
@@ -364,6 +374,8 @@ type AsTypeFunction<T> = {
 type Compare<T> = (a, b) => number;
 ```
 
+A comparator function that returns a negative number if a < b, zero if a == b, and a positive number if a > b.
+
 ## Type Parameters
 
 ### T
@@ -413,6 +425,8 @@ extended from, which then adds only those additional fields
 type StringOrAlertFunction<T> = string | AssertExMessageFunc<T>;
 ```
 
+A string message or function that produces an assertion error message for a failed type check.
+
 ## Type Parameters
 
 ### T
@@ -433,6 +447,8 @@ type TypeCheck<T> = {
 };
 ```
 
+A type guard function that checks whether a value conforms to type T, with optional configuration.
+
 ## Type Parameters
 
 ### T

package/dist/neutral/AsTypeFactory.d.ts

@@ -1,6 +1,10 @@
 import type { AnyNonPromise } from '@xylabs/promise';
 import type { AsTypeFunction } from './AsTypeFunction.ts';
 import type { TypeCheck } from './types.ts';
+/**
+ * Factory for creating type-narrowing 'as' functions that cast a value to T or return undefined.
+ * Supports optional assertion messages and configuration for required/optional behavior.
+ */
 export declare const AsTypeFactory: {
     create: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => AsTypeFunction<T>;
     createOptional: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => (value: AnyNonPromise) => T | undefined;

package/dist/neutral/AsTypeFunction.d.ts

@@ -1,5 +1,6 @@
 import type { AnyNonPromise } from '@xylabs/promise';
 import type { StringOrAlertFunction, TypeCheckConfig, TypeCheckOptionalConfig, TypeCheckRequiredConfig } from './types.ts';
+/** A type-narrowing function that attempts to cast a value to T, with optional assertion and configuration overloads. */
 export type AsTypeFunction<T extends AnyNonPromise = AnyNonPromise> = {
     <TType extends T>(value: AnyNonPromise): TType | undefined;
     <TType extends T>(value: AnyNonPromise, config: TypeCheckRequiredConfig): TType;
@@ -8,6 +9,7 @@ export type AsTypeFunction<T extends AnyNonPromise = AnyNonPromise> = {
     <TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>, config: TypeCheckRequiredConfig): TType;
     <TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>, config: TypeCheckConfig | TypeCheckOptionalConfig): TType | undefined;
 };
+/** A simplified type-narrowing function that returns T or undefined, without assertion support. */
 export type AsOptionalTypeFunction<T extends AnyNonPromise = AnyNonPromise> = {
     <TType extends T>(value: AnyNonPromise): TType | undefined;
 };

package/dist/neutral/Compare.d.ts

@@ -1 +1,2 @@
+/** A comparator function that returns a negative number if a < b, zero if a == b, and a positive number if a > b. */
 export type Compare<T> = (a: T, b: T) => number;

package/dist/neutral/types.d.ts

@@ -2,16 +2,21 @@ import type { AssertExMessageFunc } from '@xylabs/assert';
 import type { Logger } from '@xylabs/logger';
 import type { AnyNonPromise } from '@xylabs/promise';
 import type { TypedValue } from '@xylabs/typeof';
+/** Configuration options for type check functions, with optional logging. */
 export interface TypeCheckConfig {
     log?: boolean | Logger;
 }
+/** Type check configuration that marks the value as required, causing assertions on failure. */
 export interface TypeCheckRequiredConfig extends TypeCheckConfig {
     required: true;
 }
+/** Type check configuration that marks the value as optional, returning undefined on failure. */
 export interface TypeCheckOptionalConfig extends TypeCheckConfig {
     required: false;
 }
+/** A string message or function that produces an assertion error message for a failed type check. */
 export type StringOrAlertFunction<T extends AnyNonPromise> = string | AssertExMessageFunc<T>;
+/** A type guard function that checks whether a value conforms to type T, with optional configuration. */
 export type TypeCheck<T extends TypedValue> = {
     (obj: AnyNonPromise): obj is T;
     (obj: AnyNonPromise, config: TypeCheckConfig): obj is T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/object-model",
-  "version": "5.0.82",
+  "version": "5.0.84",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -35,14 +35,14 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/assert": "~5.0.82",
-    "@xylabs/logger": "~5.0.82",
-    "@xylabs/promise": "~5.0.82",
-    "@xylabs/typeof": "~5.0.82"
+    "@xylabs/assert": "~5.0.84",
+    "@xylabs/logger": "~5.0.84",
+    "@xylabs/promise": "~5.0.84",
+    "@xylabs/typeof": "~5.0.84"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.13",
+    "@xylabs/tsconfig": "~7.4.13",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
   },