API Reference
Base class for key-scoped singleton lifecycle management (create/release with reference counting).
This class keeps a reference count for each singleton key. create(...) increases the count, and release(...) decreases it. When the count reaches 0, the instance is released. It is important that every successful create(...) call has a matching release(...) call to prevent memory leaks.
Related: KeyedInstanceFactory docs
import { KeyedInstanceFactory } from '@rs-x/core';import { KeyedInstanceFactory } from '@rs-x/core';
type UserData = { id: string; name: string };
class MyKeyedInstanceFactory extends KeyedInstanceFactory<string, UserData, UserData, UserData> {
public getId(data: UserData): string | undefined {
return data.id;
}
protected createId(data: UserData): string {
return data.id;
}
protected createInstance(data: UserData): UserData {
return { ...data };
}
}
const factory = new MyKeyedInstanceFactory();
// First create: referenceCount = 1
const first = factory.create({ id: 'u1', name: 'Ada' });20 members in this abstract class.
protected constructor()Parameters
No parameters.
public exists(target: TInstance): booleanParameters
Returns
boolean
public getFromData(data: TIdData): TInstance | undefinedParameters
Returns
TInstance | undefined
public getFromId(id: TId): TInstance | undefinedParameters
Returns
TInstance | undefined
public abstract getId(data: TIdData): TId | undefinedParameters
Returns
TId | undefined
public getOrCreate(data: TData): TInstanceParameters
Returns
TInstance
public getReferenceCount(id: TId): numberParameters
Returns
number
public has(id: TId): booleanParameters
Returns
boolean
public ids(): MapIterator<TId>Parameters
No parameters.
Returns
MapIterator<TId>
public toLines(
indent: number = 4,
level: number = 0
): string[]Parameters
Returns
string[]
public toString(
indent = 4,
level = 0
): stringParameters
Returns
string
protected abstract createId(data: TIdData): TIdParameters
Returns
TId
protected abstract createInstance(
data: TData,
id: TId
): TInstanceParameters
Returns
TInstance
protected getOrCreateId(data: TIdData): TIdParameters
Returns
TId
protected onDispose(): voidParameters
No parameters.
Returns
void
protected onInstanceCreated(
_instance: TInstance,
_data: TData
): voidParameters
Returns
void
protected onReleased(): voidParameters
No parameters.
Returns
void
protected releaseInstance(
_instance: TInstance,
_id: TId
): voidParameters
Returns
void
protected replaceKey(
oldKey: TId,
newKey: TId
): voidParameters
Returns
void
protected updateReferenceCount(
id: TId,
change: 1 | -1,
instance: TInstance,
forceRelease?: boolean
): numberParameters
Returns
number