API Reference

SetKeyAccessorclass

Set accessor implementation used by the index-value-accessor pipeline. It checks membership, reads matching items, and can replace one item with another.

Quick facts
Kind
class
Implements
ISetKeyAccessor
Members
6
Package
@rs-x/core

Import

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

Example

import {
  InjectionContainer,
  RsXCoreInjectionTokens,
  RsXCoreModule,
  type ISetKeyAccessor,
} from '@rs-x/core';

await InjectionContainer.load(RsXCoreModule);

const accessor = InjectionContainer.get<ISetKeyAccessor>(
  RsXCoreInjectionTokens.ISetKeyAccessor,
);

const set = new Set<unknown>(['a', 'b']);

console.log(accessor.hasValue(set, 'b')); // true
console.log(accessor.getValue(set, 'b')); // 'b'

accessor.setValue(set, 'b', 'beta');
console.log(set.has('beta')); // true
console.log([...accessor.getIndexes(set)]); // ['a', 'beta']

Constructor injection example

import { Inject, RsXCoreInjectionTokens, type ISetKeyAccessor } from '@rs-x/core';

class MyConsumer {
  constructor(
    @Inject(RsXCoreInjectionTokens.ISetKeyAccessor)
    private readonly dependency: ISetKeyAccessor,
  ) {}
}

Members

6 members in this class.

applies
methodpublic
public applies(map: unknown): boolean

Parameters

Name
Type
Required
map
unknown
required

Returns

boolean

getIndexes
methodpublic
public getIndexes(set: Set<unknown>): IterableIterator<unknown>

Parameters

Name
Type
Required
set
Set<unknown>
required

Returns

IterableIterator<unknown>

getResolvedValue
methodpublic
public getResolvedValue(
  set: Set<unknown>,
  key: unknown
): unknown

Parameters

Name
Type
Required
set
Set<unknown>
required
key
unknown
required

Returns

unknown

getValue
methodpublic
public getValue(
  set: Set<unknown>,
  key: unknown
): unknown

Parameters

Name
Type
Required
set
Set<unknown>
required
key
unknown
required

Returns

unknown

hasValue
methodpublic
public hasValue(
  set: Set<unknown>,
  key: unknown
): boolean

Parameters

Name
Type
Required
set
Set<unknown>
required
key
unknown
required

Returns

boolean

setValue
methodpublic
public setValue(
  set: Set<unknown>,
  key: unknown,
  value: unknown
): void

Parameters

Name
Type
Required
set
Set<unknown>
required
key
unknown
required
value
unknown
required

Returns

void