API Reference

IGroupedKeyedInstanceFactoryinterface

Extended keyed-instance-factory contract that supports generated group/member ids and grouped lookup.

Quick facts

Kind: interface
Module: keyed-instance-factory
Extends: IKeyedInstanceFactory<TId, TData, TInstance, TIdData>
Members: 2
Package: @rs-x/core
Source: keyed-instance-factory/grouped-keyed-instance-factory.interface.ts

Declaration

export interface IGroupedKeyedInstanceFactory<
  TId,
  TData extends TIdData,
  TInstance,
  TIdData = TData,
> extends IKeyedInstanceFactory<TId, TData, TInstance, TIdData> {
  isGroupRegistered(groupId: unknown): boolean;
  instanceGroupInfoEntries(): IterableIterator<
    IInstanceGroupInfo<TId, TInstance>
  >;
}

Import

import type { IGroupedKeyedInstanceFactory } from '@rs-x/core';

Members

2 members in this interface.

instanceGroupInfoEntries

method

instanceGroupInfoEntries(): IterableIterator< IInstanceGroupInfo<TId, TInstance> >

Parameters

No parameters.

Returns

IterableIterator< IInstanceGroupInfo<TId, TInstance> >

isGroupRegistered

method

isGroupRegistered(groupId: unknown): boolean

Parameters

Name
Type
Required
groupId: unknown; required

Returns

boolean