@xylabs/base

[![logo][]](https://xylabs.com)

[![main-build][]][main-build-link]
[![npm-badge][]][npm-link]
[![npm-downloads-badge][]][npm-link]
[![jsdelivr-badge][]][jsdelivr-link]
[![npm-license-badge][]](LICENSE)
[![codacy-badge][]][codacy-link]
[![codeclimate-badge][]][codeclimate-link]
[![snyk-badge][]][snyk-link]
[![socket-badge][]][socket-link]

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/base

*

Classes

- Base

Type Aliases

- BaseClassName
- BaseParamsFields
- BaseParams

Functions

- disableGloballyUnique
- globallyUnique

$3

### Base

@xylabs/base

*

Type Parameters

$3

TParams extends BaseParams = BaseParams

Constructors

$3

``ts
new Base(params): Base;
`

$3

#### params

BaseParams\<TParams\>

$3

Base\<TParams\>

Properties

$3

`ts
static optional defaultLogger: Logger;
`

*

$3

`ts
readonly static globalInstances: Record[]> = {};
`

*

$3

`ts
readonly static globalInstancesCountHistory: Record = {};
`

*

$3

`ts
readonly static uniqueName: string;
`

Accessors

$3

$3

`ts
get static historyInterval(): number;
`

#### Returns

number

$3

`ts
set static historyInterval(value): void;
`

#### Parameters

##### value

number

#### Returns

void

*

$3

$3

`ts
get static historyTime(): number;
`

#### Returns

number

$3

`ts
set static historyTime(value): void;
`

#### Parameters

##### value

number

#### Returns

void

*

$3

$3

`ts
get static maxGcFrequency(): number;
`

#### Returns

number

$3

`ts
set static maxGcFrequency(value): void;
`

#### Parameters

##### value

number

#### Returns

void

*

$3

$3

`ts
get static maxHistoryDepth(): number;
`

#### Returns

number

*

$3

$3

`ts
get logger(): undefined | Logger;
`

#### Returns

undefined \| Logger

*

$3

$3

`ts
get meter(): undefined | Meter;
`

#### Returns

undefined \| Meter

*

$3

$3

`ts
get params(): BaseParams;
`

#### Returns

BaseParams\<TParams\>

*

$3

$3

`ts
get tracer(): undefined | Tracer;
`

#### Returns

undefined \| Tracer

Methods

$3

$3

`ts
static gc(force?): void;
`

#### Parameters

##### force?

boolean

#### Returns

void

$3

`ts
static gc(className): void;
`

#### Parameters

##### className

string

#### Returns

void

*

$3

`ts
static instanceCount(className): number;
`

$3

#### className

string

$3

number

*

$3

`ts
static instanceCounts(): Record;
`

$3

Record\<BaseClassName, number\>

*

$3

`ts
static startHistory(): void;
`

$3

void

*

$3

`ts
static stopHistory(): void;
`

$3

void

$3

### disableGloballyUnique

@xylabs/base

*

`ts
function disableGloballyUnique(): void;
`

Returns

void

### globallyUnique

@xylabs/base

*

`ts
function globallyUnique(
name,
value,
domain): string;
`

Parameters

$3

string

$3

unknown

$3

string = 'global'

Returns

string

$3

### BaseClassName

@xylabs/base

*

`ts
type BaseClassName = Exclude;
`

### BaseParams

@xylabs/base

*

`ts
type BaseParams = TAdditionalParams & BaseParamsFields;
`

Type Parameters

$3

TAdditionalParams extends EmptyObject = EmptyObject

### BaseParamsFields

@xylabs/base

*

`ts
type BaseParamsFields = object;
`

Properties

$3

`ts
optional logger: Logger;
`

*

$3

`ts
optional meterProvider: MeterProvider;
`

*

$3

`ts
optional traceProvider: TracerProvider;
``

Part of sdk-js

Maintainers

- Arie Trouw (arietrouw.com)
- Matt Jones
- Joel Carter
- Jordan Trouw

License

> See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs

[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
[npm-badge]: https://img.shields.io/npm/v/@xylabs/base.svg
[npm-link]: https://www.npmjs.com/package/@xylabs/base
[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json

[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/base
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/base

[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/base/badge
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/base

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/base
[socket-link]: https://socket.dev/npm/package/@xylabs/base