@xylabs/base

@xylabs/base

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/base

Classes

• Base

Type Aliases

• BaseClassName
• BaseParamsFields
• BaseParams

Functions

• disableGloballyUnique
• globallyUnique

classes

Base

@xylabs/base

Type Parameters

TParams

TParams extends BaseParams = BaseParams

Constructors

Constructor

new Base<TParams>(params): Base<TParams>;

Parameters

params

BaseParams<TParams>

Returns

Base<TParams>

Properties

defaultLogger?

static optional defaultLogger: Logger;

globalInstances

readonly static globalInstances: Record<BaseClassName, WeakRef<Base>[]> = {};

globalInstancesCountHistory

readonly static globalInstancesCountHistory: Record<BaseClassName, number[]> = {};

uniqueName

readonly static uniqueName: string;

Accessors

historyInterval

Get Signature

get static historyInterval(): number;

Returns

number

Set Signature

set static historyInterval(value): void;

Parameters

value

number

Returns

void

historyTime

Get Signature

get static historyTime(): number;

Returns

number

Set Signature

set static historyTime(value): void;

Parameters

value

number

Returns

void

maxGcFrequency

Get Signature

get static maxGcFrequency(): number;

Returns

number

Set Signature

set static maxGcFrequency(value): void;

Parameters

value

number

Returns

void

maxHistoryDepth

Get Signature

get static maxHistoryDepth(): number;

Returns

number

logger

Get Signature

get logger(): undefined | Logger;

Returns

undefined | Logger

meter

Get Signature

get meter(): undefined | Meter;

Returns

undefined | Meter

params

Get Signature

get params(): BaseParams<TParams>;

Returns

BaseParams<TParams>

tracer

Get Signature

get tracer(): undefined | Tracer;

Returns

undefined | Tracer

Methods

gc()

Call Signature

static gc(force?): void;

Parameters

force?

boolean

Returns

void

Call Signature

static gc(className): void;

Parameters

className

string

Returns

void

instanceCount()

static instanceCount(className): number;

Parameters

className

string

Returns

number

instanceCounts()

static instanceCounts(): Record<BaseClassName, number>;

Returns

Record<BaseClassName, number>

startHistory()

static startHistory(): void;

Returns

void

stopHistory()

static stopHistory(): void;

Returns

void

functions

disableGloballyUnique

@xylabs/base

function disableGloballyUnique(): void;

Returns

void

globallyUnique

@xylabs/base

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

Parameters

name

string

value

unknown

domain

string = 'global'

Returns

string

type-aliases

BaseClassName

@xylabs/base

type BaseClassName = Exclude<string, "base-class-name-reserved-32546239486">;

BaseParams

@xylabs/base

type BaseParams<TAdditionalParams> = TAdditionalParams & BaseParamsFields;

Type Parameters

TAdditionalParams

TAdditionalParams extends EmptyObject = EmptyObject

BaseParamsFields

@xylabs/base

type BaseParamsFields = object;

Properties

logger?

optional logger: Logger;

meterProvider?

optional meterProvider: MeterProvider;

traceProvider?

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