API Reference

ArrayIndexAccessorclass

Array accessor implementation used by the index-value-accessor pipeline. It handles Array contexts, reads and writes values by numeric index (array[index]), reports whether an index has a value, and lists available indexes with array.keys().

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

Import

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

Example

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

await InjectionContainer.load(RsXCoreModule);

const arrayAccessor = InjectionContainer.get<IArrayIndexAccessor>(
  RsXCoreInjectionTokens.IArrayIndexAccessor,
);

const values = ['a', 'b', 'c'];
const hasSecond = arrayAccessor.hasValue(values, 1);
const second = arrayAccessor.getValue(values, 1);

arrayAccessor.setValue(values, 1, 'beta');
const indexes = [...arrayAccessor.getIndexes(values)];

console.log(hasSecond); // true
console.log(second); // b

Constructor injection example

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

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

Members

6 members in this class.

applies
methodpublic
public applies(array: unknown): boolean

Parameters

Name
Type
Required
array
unknown
required

Returns

boolean

getIndexes
methodpublic
public getIndexes(array: unknown[]): IterableIterator<number>

Parameters

Name
Type
Required
array
unknown[]
required

Returns

IterableIterator<number>

getResolvedValue
methodpublic
public getResolvedValue(
  array: unknown[],
  index: number
): unknown

Parameters

Name
Type
Required
array
unknown[]
required
index
number
required

Returns

unknown

getValue
methodpublic
public getValue(
  array: unknown[],
  index: number
): unknown

Parameters

Name
Type
Required
array
unknown[]
required
index
number
required

Returns

unknown

hasValue
methodpublic
public hasValue(
  array: unknown[],
  index: number
): boolean

Parameters

Name
Type
Required
array
unknown[]
required
index
number
required

Returns

boolean

setValue
methodpublic
public setValue(
  array: unknown[],
  index: number,
  value: unknown
): void

Parameters

Name
Type
Required
array
unknown[]
required
index
number
required
value
unknown
required

Returns

void