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
| Name | Type | Required |
|---|---|---|
| target | TInstance | required |
Returns
boolean
public getFromData(data: TIdData): TInstance | undefinedParameters
| Name | Type | Required |
|---|---|---|
| data | TIdData | required |
Returns
TInstance | undefined
public getFromId(id: TId): TInstance | undefinedParameters
| Name | Type | Required |
|---|---|---|
| id | TId | required |
Returns
TInstance | undefined
public abstract getId(data: TIdData): TId | undefinedParameters
| Name | Type | Required |
|---|---|---|
| data | TIdData | required |
Returns
TId | undefined
public getOrCreate(data: TData): TInstanceParameters
| Name | Type | Required |
|---|---|---|
| data | TData | required |
Returns
TInstance
public getReferenceCount(id: TId): numberParameters
| Name | Type | Required |
|---|---|---|
| id | TId | required |
Returns
number
public has(id: TId): booleanParameters
| Name | Type | Required |
|---|---|---|
| id | TId | required |
Returns
boolean
public ids(): MapIterator<TId>Parameters
No parameters.
Returns
MapIterator<TId>
public toLines(
indent: number = 4,
level: number = 0
): string[]Parameters
| Name | Type | Required |
|---|---|---|
| indent? | number | optional |
| level? | number | optional |
Returns
string[]
public toString(
indent = 4,
level = 0
): stringParameters
| Name | Type | Required |
|---|---|---|
| indent? | unknown | optional |
| level? | unknown | optional |
Returns
string
protected abstract createId(data: TIdData): TIdParameters
| Name | Type | Required |
|---|---|---|
| data | TIdData | required |
Returns
TId
protected abstract createInstance(
data: TData,
id: TId
): TInstanceParameters
| Name | Type | Required |
|---|---|---|
| data | TData | required |
| id | TId | required |
Returns
TInstance
protected getOrCreateId(data: TIdData): TIdParameters
| Name | Type | Required |
|---|---|---|
| data | TIdData | required |
Returns
TId
protected onDispose(): voidParameters
No parameters.
Returns
void
protected onInstanceCreated(
_instance: TInstance,
_data: TData
): voidParameters
| Name | Type | Required |
|---|---|---|
| _instance | TInstance | required |
| _data | TData | required |
Returns
void
protected onReleased(): voidParameters
No parameters.
Returns
void
protected releaseInstance(
_instance: TInstance,
_id: TId
): voidParameters
| Name | Type | Required |
|---|---|---|
| _instance | TInstance | required |
| _id | TId | required |
Returns
void
protected replaceKey(
oldKey: TId,
newKey: TId
): voidParameters
| Name | Type | Required |
|---|---|---|
| oldKey | TId | required |
| newKey | TId | required |
Returns
void
protected updateReferenceCount(
id: TId,
change: 1 | -1,
instance: TInstance,
forceRelease?: boolean
): numberParameters
| Name | Type | Required |
|---|---|---|
| id | TId | required |
| change | 1 | -1 | required |
| instance | TInstance | required |
| forceRelease? | boolean | optional |
Returns
number