API Reference

MapKeyAccessorclass

Map accessor implementation used by the index-value-accessor pipeline. It reads and writes values by map key and enumerates map keys.

Quick facts
Kind
class
Module
index-value-accessor
Implements
IMapKeyAccessor
Members
6
Package
@rs-x/core
Source
index-value-accessor/map-key-accessor.ts

Import

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

Example

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

await InjectionContainer.load(RsXCoreModule);

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

const map = new Map<unknown, unknown>([['x', 10]]);

console.log(accessor.hasValue(map, 'x')); // true
console.log(accessor.getValue(map, 'x')); // 10

accessor.setValue(map, 'x', 20);
console.log(accessor.getValue(map, 'x')); // 20
console.log([...accessor.getIndexes(map)]); // ['x']

Constructor injection example

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

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

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( map: Map<unknown, unknown>): IterableIterator<unknown, unknown, unknown>

Parameters

Name
Type
Required
map
Map<unknown, unknown>
required

Returns

IterableIterator<unknown, unknown, unknown>

getResolvedValue
methodpublic
public getResolvedValue(
  map: Map<unknown, unknown>,
  key: unknown
): unknown

Parameters

Name
Type
Required
map
Map<unknown, unknown>
required
key
unknown
required

Returns

unknown

getValue
methodpublic
public getValue(
  map: Map<unknown, unknown>,
  key: unknown
): unknown

Parameters

Name
Type
Required
map
Map<unknown, unknown>
required
key
unknown
required

Returns

unknown

hasValue
methodpublic
public hasValue(
  map: Map<unknown, unknown>,
  key: unknown
): boolean

Parameters

Name
Type
Required
map
Map<unknown, unknown>
required
key
unknown
required

Returns

boolean

setValue
methodpublic
public setValue(
  map: Map<unknown, unknown>,
  key: unknown,
  value: unknown
): void

Parameters

Name
Type
Required
map
Map<unknown, unknown>
required
key
unknown
required
value
unknown
required

Returns

void