When to use
Use this when your key is derived from a group + member identity (for example room + user). Each successful create(...) call must be matched with release(id) to prevent memory leaks.
Related: KeyedInstanceFactory docs
API Reference
GroupedKeyedInstanceFactoryabstract class
Base class for grouped keyed instances where ids are generated per group/member combination.
Import
import { GroupedKeyedInstanceFactory } from '@rs-x/core';Example
import { GroupedKeyedInstanceFactory } from '@rs-x/core';
type ChatSubscriptionData = {
roomId: string;
userId: string;
};
class ChatSubscription {
constructor(
public readonly roomId: string,
public readonly userId: string,
) {}
public dispose(): void {
// teardown logic (unsubscribe/close/etc.)
}
}
class ChatSubscriptionFactory extends GroupedKeyedInstanceFactory<
string,
ChatSubscriptionData,
ChatSubscriptionMembers
10 members in this abstract class.
getId
methodpublic
public getId(data: TIdData): TId | undefinedParameters
- Name
- Type
- Required
- data
- TIdData
- required
Returns
TId | undefined
isGroupRegistered
methodpublic
public isGroupRegistered(groupId: unknown): booleanParameters
- Name
- Type
- Required
- groupId
- unknown
- required
Returns
boolean
createId
methodprotected
protected createId(data: TData): TIdParameters
- Name
- Type
- Required
- data
- TData
- required
Returns
TId
createUniqueId
methodprotectedabstract
protected abstract createUniqueId(data: TIdData): TIdParameters
- Name
- Type
- Required
- data
- TIdData
- required
Returns
TId
getGroup
methodprotected
protected getGroup<T>(groupId: unknown): Map<T, TId> | undefinedParameters
- Name
- Type
- Required
- groupId
- unknown
- required
Returns
Map<T, TId> | undefined
getGroupId
methodprotectedabstract
protected abstract getGroupId(data: TIdData): unknownParameters
- Name
- Type
- Required
- data
- TIdData
- required
Returns
unknown
getGroupMemberId
methodprotectedabstract
protected abstract getGroupMemberId(data: TIdData): unknownParameters
- Name
- Type
- Required
- data
- TIdData
- required
Returns
unknown
getOrCreateId
methodprotected
protected override getOrCreateId(data: TIdData): TIdParameters
- Name
- Type
- Required
- data
- TIdData
- required
Returns
TId
onDispose
methodprotected
protected override onDispose(): voidParameters
No parameters.
Returns
void
releaseInstance
methodprotected
protected override releaseInstance(
_instance: TInstance,
id: TId
): voidParameters
- Name
- Type
- Required
- _instance
- TInstance
- required
- id
- TId
- required
Returns
void