@xylabs/base 4.13.20 → 4.13.21

package/README.md

@@ -12,13 +12,453 @@
 [![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/base**
+
+***
+
+## Classes
+
+- [Base](#classes/Base)
+
+## Type Aliases
+
+- [BaseClassName](#type-aliases/BaseClassName)
+- [BaseParamsFields](#type-aliases/BaseParamsFields)
+- [BaseParams](#type-aliases/BaseParams)
+
+## Functions
+
+- [disableGloballyUnique](#functions/disableGloballyUnique)
+- [globallyUnique](#functions/globallyUnique)
+
+### classes
+
+  ### <a id="Base"></a>Base
+
+[**@xylabs/base**](#../README)
+
+***
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`BaseParams`](#../type-aliases/BaseParams) = [`BaseParams`](#../type-aliases/BaseParams)
+
+## Constructors
+
+### Constructor
+
+```ts
+new Base<TParams>(params): Base<TParams>;
+```
+
+### Parameters
+
+#### params
+
+[`BaseParams`](#../type-aliases/BaseParams)\<`TParams`\>
+
+### Returns
+
+`Base`\<`TParams`\>
+
+## Properties
+
+### defaultLogger?
+
+```ts
+static optional defaultLogger: Logger;
+```
+
+***
+
+### globalInstances
+
+```ts
+readonly static globalInstances: Record<BaseClassName, WeakRef<Base>[]> = {};
+```
+
+***
+
+### globalInstancesCountHistory
+
+```ts
+readonly static globalInstancesCountHistory: Record<BaseClassName, number[]> = {};
+```
+
+***
+
+### uniqueName
+
+```ts
+readonly static uniqueName: string;
+```
+
+## Accessors
+
+### historyInterval
+
+### Get Signature
+
+```ts
+get static historyInterval(): number;
+```
+
+#### Returns
+
+`number`
+
+### Set Signature
+
+```ts
+set static historyInterval(value): void;
+```
+
+#### Parameters
+
+##### value
+
+`number`
+
+#### Returns
+
+`void`
+
+***
+
+### historyTime
+
+### Get Signature
+
+```ts
+get static historyTime(): number;
+```
+
+#### Returns
+
+`number`
+
+### Set Signature
+
+```ts
+set static historyTime(value): void;
+```
+
+#### Parameters
+
+##### value
+
+`number`
+
+#### Returns
+
+`void`
+
+***
+
+### maxGcFrequency
+
+### Get Signature
+
+```ts
+get static maxGcFrequency(): number;
+```
+
+#### Returns
+
+`number`
+
+### Set Signature
+
+```ts
+set static maxGcFrequency(value): void;
+```
+
+#### Parameters
+
+##### value
+
+`number`
+
+#### Returns
+
+`void`
+
+***
+
+### maxHistoryDepth
+
+### Get Signature
+
+```ts
+get static maxHistoryDepth(): number;
+```
+
+#### Returns
+
+`number`
+
+***
+
+### logger
+
+### Get Signature
+
+```ts
+get logger(): undefined | Logger;
+```
+
+#### Returns
+
+`undefined` \| `Logger`
+
+***
+
+### meter
+
+### Get Signature
+
+```ts
+get meter(): undefined | Meter;
+```
+
+#### Returns
+
+`undefined` \| `Meter`
+
+***
+
+### params
+
+### Get Signature
+
+```ts
+get params(): BaseParams<TParams>;
+```
+
+#### Returns
+
+[`BaseParams`](#../type-aliases/BaseParams)\<`TParams`\>
+
+***
+
+### tracer
+
+### Get Signature
+
+```ts
+get tracer(): undefined | Tracer;
+```
+
+#### Returns
+
+`undefined` \| `Tracer`
+
+## Methods
+
+### gc()
+
+### Call Signature
+
+```ts
+static gc(force?): void;
+```
+
+#### Parameters
+
+##### force?
+
+`boolean`
+
+#### Returns
+
+`void`
+
+### Call Signature
+
+```ts
+static gc(className): void;
+```
+
+#### Parameters
+
+##### className
+
+`string`
+
+#### Returns
+
+`void`
+
+***
+
+### instanceCount()
+
+```ts
+static instanceCount(className): number;
+```
+
+### Parameters
+
+#### className
+
+`string`
+
+### Returns
+
+`number`
+
+***
+
+### instanceCounts()
+
+```ts
+static instanceCounts(): Record<BaseClassName, number>;
+```
+
+### Returns
+
+`Record`\<[`BaseClassName`](#../type-aliases/BaseClassName), `number`\>
+
+***
+
+### startHistory()
+
+```ts
+static startHistory(): void;
+```
+
+### Returns
+
+`void`
+
+***
+
+### stopHistory()
+
+```ts
+static stopHistory(): void;
+```
+
+### Returns
+
+`void`
+
+### functions
+
+  ### <a id="disableGloballyUnique"></a>disableGloballyUnique
+
+[**@xylabs/base**](#../README)
+
+***
+
+```ts
+function disableGloballyUnique(): void;
+```
+
+## Returns
+
+`void`
+
+  ### <a id="globallyUnique"></a>globallyUnique
+
+[**@xylabs/base**](#../README)
+
+***
+
+```ts
+function globallyUnique(
+   name, 
+   value, 
+   domain): string;
+```
+
+## Parameters
+
+### name
+
+`string`
+
+### value
+
+`unknown`
+
+### domain
+
+`string` = `'global'`
+
+## Returns
+
+`string`
+
+### type-aliases
+
+  ### <a id="BaseClassName"></a>BaseClassName
+
+[**@xylabs/base**](#../README)
+
+***
+
+```ts
+type BaseClassName = Exclude<string, "base-class-name-reserved-32546239486">;
+```
+
+  ### <a id="BaseParams"></a>BaseParams
+
+[**@xylabs/base**](#../README)
+
+***
+
+```ts
+type BaseParams<TAdditionalParams> = TAdditionalParams & BaseParamsFields;
+```
+
+## Type Parameters
+
+### TAdditionalParams
+
+`TAdditionalParams` *extends* `EmptyObject` = `EmptyObject`
+
+  ### <a id="BaseParamsFields"></a>BaseParamsFields
+
+[**@xylabs/base**](#../README)
+
+***
+
+```ts
+type BaseParamsFields = object;
+```
+
+## Properties
+
+### logger?
+
+```ts
+optional logger: Logger;
+```
+
+***
+
+### meterProvider?
+
+```ts
+optional meterProvider: MeterProvider;
+```
+
+***
+
+### traceProvider?
+
+```ts
+optional traceProvider: TracerProvider;
+```
 
-Coming Soon!
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xylabs/base",
-  "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",
@@ -36,9 +36,9 @@
   ],
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@xylabs/assert": "^4.13.20",
-    "@xylabs/logger": "^4.13.20",
-    "@xylabs/object": "^4.13.20"
+    "@xylabs/assert": "^4.13.21",
+    "@xylabs/logger": "^4.13.21",
+    "@xylabs/object": "^4.13.21"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^7.0.0",