diff --git a/packages/collection/__tests__/collection.test-d.ts b/packages/collection/__tests__/collection.test-d.ts new file mode 100644 index 000000000..3a9bedbb2 --- /dev/null +++ b/packages/collection/__tests__/collection.test-d.ts @@ -0,0 +1,16 @@ +import { expectTypeOf, test } from 'vitest'; +import { Collection, type ReadonlyCollection } from '../src/index.js'; + +test('ReadonlyCollection#tap preserves the readonly type', () => { + const readonly: ReadonlyCollection = new Collection([['a', 1]]); + + expectTypeOf(readonly.tap(() => {})).toEqualTypeOf>(); + expectTypeOf(readonly.tap(() => {}, null)).toEqualTypeOf>(); +}); + +test('ReadonlyCollection#each preserves the readonly type', () => { + const readonly: ReadonlyCollection = new Collection([['a', 1]]); + + expectTypeOf(readonly.each(() => {})).toEqualTypeOf>(); + expectTypeOf(readonly.each(() => {}, null)).toEqualTypeOf>(); +}); diff --git a/packages/collection/src/collection.ts b/packages/collection/src/collection.ts index 9e2930ef4..f6800a181 100644 --- a/packages/collection/src/collection.ts +++ b/packages/collection/src/collection.ts @@ -5,9 +5,22 @@ */ export type ReadonlyCollection = Omit< Collection, - keyof Map | 'ensure' | 'reverse' | 'sort' | 'sweep' + keyof Map | 'each' | 'ensure' | 'reverse' | 'sort' | 'sweep' | 'tap' > & - ReadonlyMap; + ReadonlyMap & { + each( + fn: (value: Value, key: Key, collection: ReadonlyCollection) => void, + ): ReadonlyCollection; + each( + fn: (this: This, value: Value, key: Key, collection: ReadonlyCollection) => void, + thisArg: This, + ): ReadonlyCollection; + tap(fn: (collection: ReadonlyCollection) => void): ReadonlyCollection; + tap( + fn: (this: This, collection: ReadonlyCollection) => void, + thisArg: This, + ): ReadonlyCollection; + }; export interface Collection { /**