Skip to content
This repository was archived by the owner on Jan 6, 2026. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions packages/@glimmer/validator/lib/collections/array.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@
import { consumeTag } from '../tracking';
import { createUpdatableTag, DIRTY_TAG } from '../validators';

type Options<T> = {
equals: (a: T, b: T) => boolean;
description: string | undefined;
unsafeSkipMakingCopy: boolean;
};

const ARRAY_GETTER_METHODS = new Set<string | symbol | number>([
Symbol.iterator,
'concat',
Expand Down Expand Up @@ -49,15 +55,12 @@ function convertToInt(prop: number | string | symbol): number | null {

// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
class TrackedArray<T = unknown> {
#options: { equals: (a: T, b: T) => boolean; description: string | undefined };
#options: Options<T>;

constructor(
arr: T[],
options: { equals: (a: T, b: T) => boolean; description: string | undefined }
) {
constructor(arr: T[], options: Options<T>) {
this.#options = options;

const clone = arr.slice();
const array = options.unsafeSkipMakingCopy ? arr : arr.slice();
// eslint-disable-next-line @typescript-eslint/no-this-alias
const self = this;

Expand All @@ -70,7 +73,7 @@ class TrackedArray<T = unknown> {
*/
let nativelyAccessingLengthFromPushOrUnshift = false;

return new Proxy(clone, {
return new Proxy(array, {
get(target, prop /*, _receiver */) {
const index = convertToInt(prop);

Expand Down Expand Up @@ -197,12 +200,10 @@ interface TrackedArray<T = unknown> extends Array<T> {}
// Ensure instanceof works correctly
Object.setPrototypeOf(TrackedArray.prototype, Array.prototype);

export function trackedArray<T = unknown>(
data?: T[],
options?: { equals?: (a: T, b: T) => boolean; description?: string }
): T[] {
export function trackedArray<T = unknown>(data?: T[], options?: Partial<Options<T>>): T[] {
return new TrackedArray(data ?? [], {
equals: options?.equals ?? Object.is,
description: options?.description,
unsafeSkipMakingCopy: options?.unsafeSkipMakingCopy ?? false,
});
}
13 changes: 13 additions & 0 deletions packages/@glimmer/validator/test/collections/array-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,19 @@ module('@glimmer/validator: trackedArray()', () => {
assert.strictEqual(arr[0], undefined);
});

test('Can skip creating a copy', (assert) => {
let original = [123];
let arr = trackedArray(original);
original[0]++;

assert.strictEqual(arr[0], 123);

arr = trackedArray(original, { unsafeSkipMakingCopy: true });
original[0]++;

assert.strictEqual(arr[0], 125);
});

module('methods', () => {
test('isArray', (assert) => {
let arr = trackedArray();
Expand Down
Loading