@xylabs/object-model 4.13.20 → 4.13.21

package/README.md

@@ -12,13 +12,469 @@
 [![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-Version: 4.13.19
 
-Primary SDK for using XYO Protocol 2.0
+Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-## Documentation
+## API Documentation
+
+**@xylabs/object-model**
+
+***
+
+## Interfaces
+
+- [TypeCheckConfig](#interfaces/TypeCheckConfig)
+- [TypeCheckRequiredConfig](#interfaces/TypeCheckRequiredConfig)
+- [TypeCheckOptionalConfig](#interfaces/TypeCheckOptionalConfig)
+
+## Type Aliases
+
+- [AnyObject](#type-aliases/AnyObject)
+- [AsTypeFunction](#type-aliases/AsTypeFunction)
+- [AsOptionalTypeFunction](#type-aliases/AsOptionalTypeFunction)
+- [Compare](#type-aliases/Compare)
+- [StringOrAlertFunction](#type-aliases/StringOrAlertFunction)
+- [TypeCheck](#type-aliases/TypeCheck)
+
+### interfaces
+
+  ### <a id="TypeCheckConfig"></a>TypeCheckConfig
+
+[**@xylabs/object-model**](#../README)
+
+***
+
+## Extended by
+
+- [`TypeCheckRequiredConfig`](#TypeCheckRequiredConfig)
+- [`TypeCheckOptionalConfig`](#TypeCheckOptionalConfig)
+
+## Properties
+
+### log?
+
+```ts
+optional log: boolean | Logger;
+```
+
+  ### <a id="TypeCheckOptionalConfig"></a>TypeCheckOptionalConfig
+
+[**@xylabs/object-model**](#../README)
+
+***
+
+## Extends
+
+- [`TypeCheckConfig`](#TypeCheckConfig)
+
+## Properties
+
+### log?
+
+```ts
+optional log: boolean | Logger;
+```
+
+### Inherited from
+
+[`TypeCheckConfig`](#TypeCheckConfig).[`log`](TypeCheckConfig.md#log)
+
+***
+
+### required
+
+```ts
+required: false;
+```
+
+  ### <a id="TypeCheckRequiredConfig"></a>TypeCheckRequiredConfig
+
+[**@xylabs/object-model**](#../README)
+
+***
+
+## Extends
+
+- [`TypeCheckConfig`](#TypeCheckConfig)
+
+## Properties
+
+### log?
+
+```ts
+optional log: boolean | Logger;
+```
+
+### Inherited from
+
+[`TypeCheckConfig`](#TypeCheckConfig).[`log`](TypeCheckConfig.md#log)
+
+***
+
+### required
+
+```ts
+required: true;
+```
+
+### type-aliases
+
+  ### <a id="AnyObject"></a>AnyObject
+
+[**@xylabs/object-model**](#../README)
+
+***
+
+```ts
+type AnyObject = Record<TypedKey, unknown>;
+```
+
+Any object, which means that it does not enforce the set of fields that it has.  Extending from AnyObject
+will result in a type that includes the universal set of field names
+
+  ### <a id="AsOptionalTypeFunction"></a>AsOptionalTypeFunction
+
+[**@xylabs/object-model**](#../README)
+
+***
+
+```ts
+type AsOptionalTypeFunction<T> = <TType>(value) => undefined | TType;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `AnyNonPromise` = `AnyNonPromise`
+
+## Type Parameters
+
+### TType
+
+`TType` *extends* `AnyNonPromise`
+
+## Parameters
+
+### value
+
+`AnyNonPromise`
+
+## Returns
+
+`undefined` \| `TType`
+
+  ### <a id="AsTypeFunction"></a>AsTypeFunction
+
+[**@xylabs/object-model**](#../README)
+
+***
+
+```ts
+type AsTypeFunction<T> = {
+<TType>  (value): undefined | TType;
+<TType>  (value, config): TType;
+<TType>  (value, config): undefined | TType;
+<TType>  (value, assert): undefined | TType;
+<TType>  (value, assert, config): TType;
+<TType>  (value, assert, config): undefined | TType;
+};
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `AnyNonPromise` = `AnyNonPromise`
+
+## Call Signature
+
+```ts
+<TType>(value): undefined | TType;
+```
+
+### Type Parameters
+
+### TType
+
+`TType` *extends* `AnyNonPromise`
+
+### Parameters
+
+### value
+
+`AnyNonPromise`
+
+### Returns
+
+`undefined` \| `TType`
+
+## Call Signature
+
+```ts
+<TType>(value, config): TType;
+```
+
+### Type Parameters
+
+### TType
+
+`TType` *extends* `AnyNonPromise`
+
+### Parameters
+
+### value
+
+`AnyNonPromise`
+
+### config
+
+[`TypeCheckRequiredConfig`](#../interfaces/TypeCheckRequiredConfig)
+
+### Returns
+
+`TType`
+
+## Call Signature
+
+```ts
+<TType>(value, config): undefined | TType;
+```
+
+### Type Parameters
+
+### TType
+
+`TType` *extends* `AnyNonPromise`
+
+### Parameters
+
+### value
+
+`AnyNonPromise`
+
+### config
+
+[`TypeCheckConfig`](#../interfaces/TypeCheckConfig) | [`TypeCheckOptionalConfig`](#../interfaces/TypeCheckOptionalConfig)
+
+### Returns
+
+`undefined` \| `TType`
+
+## Call Signature
+
+```ts
+<TType>(value, assert): undefined | TType;
+```
+
+### Type Parameters
+
+### TType
+
+`TType` *extends* `AnyNonPromise`
+
+### Parameters
+
+### value
+
+`AnyNonPromise`
+
+### assert
+
+[`StringOrAlertFunction`](#StringOrAlertFunction)\<`TType`\>
+
+### Returns
+
+`undefined` \| `TType`
+
+## Call Signature
+
+```ts
+<TType>(
+   value, 
+   assert, 
+   config): TType;
+```
+
+### Type Parameters
+
+### TType
+
+`TType` *extends* `AnyNonPromise`
+
+### Parameters
+
+### value
+
+`AnyNonPromise`
+
+### assert
+
+[`StringOrAlertFunction`](#StringOrAlertFunction)\<`TType`\>
+
+### config
+
+[`TypeCheckRequiredConfig`](#../interfaces/TypeCheckRequiredConfig)
+
+### Returns
+
+`TType`
+
+## Call Signature
+
+```ts
+<TType>(
+   value, 
+   assert, 
+   config): undefined | TType;
+```
+
+### Type Parameters
+
+### TType
+
+`TType` *extends* `AnyNonPromise`
+
+### Parameters
+
+### value
+
+`AnyNonPromise`
+
+### assert
+
+[`StringOrAlertFunction`](#StringOrAlertFunction)\<`TType`\>
+
+### config
+
+[`TypeCheckConfig`](#../interfaces/TypeCheckConfig) | [`TypeCheckOptionalConfig`](#../interfaces/TypeCheckOptionalConfig)
+
+### Returns
+
+`undefined` \| `TType`
+
+  ### <a id="Compare"></a>Compare
+
+[**@xylabs/object-model**](#../README)
+
+***
+
+```ts
+type Compare<T> = (a, b) => number;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### a
+
+`T`
+
+### b
+
+`T`
+
+## Returns
+
+`number`
+
+  ### <a id="StringOrAlertFunction"></a>StringOrAlertFunction
+
+[**@xylabs/object-model**](#../README)
+
+***
+
+```ts
+type StringOrAlertFunction<T> = string | AssertExMessageFunc<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `AnyNonPromise`
+
+  ### <a id="TypeCheck"></a>TypeCheck
+
+[**@xylabs/object-model**](#../README)
+
+***
+
+```ts
+type TypeCheck<T> = {
+  (obj): obj is T;
+  (obj, config): obj is T;
+  (obj, config): obj is T;
+};
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `TypedValue`
+
+## Call Signature
+
+```ts
+(obj): obj is T;
+```
+
+### Parameters
+
+### obj
+
+`AnyNonPromise`
+
+### Returns
+
+`obj is T`
+
+## Call Signature
+
+```ts
+(obj, config): obj is T;
+```
+
+### Parameters
+
+### obj
+
+`AnyNonPromise`
+
+### config
+
+[`TypeCheckConfig`](#../interfaces/TypeCheckConfig)
+
+### Returns
+
+`obj is T`
+
+## Call Signature
+
+```ts
+(obj, config): obj is T;
+```
+
+### Parameters
+
+### obj
+
+`AnyNonPromise`
+
+### config
+
+`undefined` | `number` | [`TypeCheckConfig`](#../interfaces/TypeCheckConfig)
+
+### Returns
+
+`obj is T`
 
-Coming Soon!
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xylabs/object-model",
-  "version": "4.13.20",
-  "description": "Primary SDK for using XYO Protocol 2.0",
+  "version": "4.13.21",
+  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "homepage": "https://xyo.network",
   "bugs": {
     "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues",
@@ -35,10 +35,10 @@
     "src"
   ],
   "dependencies": {
-    "@xylabs/assert": "^4.13.20",
-    "@xylabs/logger": "^4.13.20",
-    "@xylabs/promise": "^4.13.20",
-    "@xylabs/typeof": "^4.13.20"
+    "@xylabs/assert": "^4.13.21",
+    "@xylabs/logger": "^4.13.21",
+    "@xylabs/promise": "^4.13.21",
+    "@xylabs/typeof": "^4.13.21"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^7.0.0",