Skip to content

test(signals): update signal test to use vitest expectTypeOf #5127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
santoshyadavdev wants to merge 6 commits into
base: main
Choose a base branch
from
Open

test(signals): update signal test to use vitest expectTypeOf #5127

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1fa292c
chore(signals): update signal test to use vitest expectTypeOf
santoshyadavdev Mar 24, 2026
b287e02
test(signals): update signal test to use vitest expectTypeOf
santoshyadavdev Mar 25, 2026
6f26e95
test(signals): update signal test to use vitest expectTypeOf
santoshyadavdev Mar 25, 2026
dce9057
test(signals): update signal test to use vitest expectTypeOf
santoshyadavdev Mar 25, 2026
59c04c7
test(signals): update signal test to use vitest expectTypeOf
santoshyadavdev Apr 6, 2026
3ff684b
test(signals): update signal test to use vitest expectTypeOf
santoshyadavdev Apr 6, 2026
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
12 changes: 0 additions & 12 deletions modules/signals/spec/types/helpers.ts
View file
Open in desktop

This file was deleted.

99 changes: 38 additions & 61 deletions modules/signals/spec/types/patch-state.types.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,78 +1,55 @@
import { expecter } from 'ts-snippet';
import { compilerOptions } from './helpers';
import { PartialStateUpdater, patchState, signalState } from '@ngrx/signals';

describe('patchState', () => {
const expectSnippet = expecter(
(code) => `
import {
PartialStateUpdater,
patchState,
signalState,
} from '@ngrx/signals';

const state = signalState({ count: 1, foo: 'bar' });

function increment(): PartialStateUpdater<{ count: number }> {
return ({ count }) => ({ count: count + 1 });
}
function increment(): PartialStateUpdater<{ count: number }> {
return ({ count }) => ({ count: count + 1 });
}

function addNumber(num: number): PartialStateUpdater<{
numbers: number[];
}> {
return ({ numbers }) => ({ numbers: [...numbers, num] });
}

${code}
`,
compilerOptions()
);
function addNumber(num: number): PartialStateUpdater<{ numbers: number[] }> {
return ({ numbers }) => ({ numbers: [...numbers, num] });
}

describe('patchState', () => {
it('infers the state type from WritableStateSource with updater', () => {
expectSnippet('patchState(state, increment())').toSucceed();
const state = signalState({ count: 1, foo: 'bar' });
patchState(state, increment());
});

it('infers the state type from WritableStateSource with object', () => {
expectSnippet("patchState(state, { foo: 'baz' })").toSucceed();
const state = signalState({ count: 1, foo: 'bar' });
patchState(state, { foo: 'baz' });
});

it('infers the state type from WritableStateSource with updater and object', () => {
expectSnippet("patchState(state, { foo: 'baz' }, increment())").toSucceed();
expectSnippet("patchState(state, increment(), { foo: 'baz' })").toSucceed();
const state = signalState({ count: 1, foo: 'bar' });
patchState(state, { foo: 'baz' }, increment());
patchState(state, increment(), { foo: 'baz' });
});

it('fails with wrong partial state object', () => {
expectSnippet('patchState(state, { x: 1 })').toFail(
/'x' does not exist in type 'Partial<NoInfer<{ count: number; foo: string; }>>/
);
expectSnippet("patchState(state, { foo: 'baz' }, { x: 1 })").toFail(
/'x' does not exist in type 'Partial<NoInfer<{ count: number; foo: string; }>>/
);
expectSnippet('patchState(state, { x: 1 }, { count: 0 })').toFail(
/'x' does not exist in type 'Partial<NoInfer<{ count: number; foo: string; }>>/
);
expectSnippet('patchState(state, increment(), { x: 1 })').toFail(
/'x' does not exist in type 'Partial<NoInfer<{ count: number; foo: string; }>>/
);
expectSnippet('patchState(state, { x: 1 }, increment())').toFail(
/'x' does not exist in type 'Partial<NoInfer<{ count: number; foo: string; }>>/
);
const state = signalState({ count: 1, foo: 'bar' });
// @ts-expect-error - 'x' does not exist in type 'Partial<NoInfer<{ count: number; foo: string; }>> | PartialStateUpdater<NoInfer<{ count: number; foo: string; }>>'
patchState(state, { x: 1 });
// @ts-expect-error - 'x' does not exist in type 'Partial<NoInfer<{ count: number; foo: string; }>> | PartialStateUpdater<NoInfer<{ count: number; foo: string; }>>'
patchState(state, { foo: 'baz' }, { x: 1 });
// @ts-expect-error - 'x' does not exist in type 'Partial<NoInfer<{ count: number; foo: string; }>> | PartialStateUpdater<NoInfer<{ count: number; foo: string; }>>'
patchState(state, { x: 1 }, { count: 0 });
// @ts-expect-error - 'x' does not exist in type 'Partial<NoInfer<{ count: number; foo: string; }>> | PartialStateUpdater<NoInfer<{ count: number; foo: string; }>>'
patchState(state, increment(), { x: 1 });
// @ts-expect-error - 'x' does not exist in type 'Partial<NoInfer<{ count: number; foo: string; }>> | PartialStateUpdater<NoInfer<{ count: number; foo: string; }>>'
patchState(state, { x: 1 }, increment());
});

it('fails with wrong partial state updater', () => {
expectSnippet('patchState(state, addNumber(10))').toFail(
/Property 'numbers' is missing in type '{ count: number; foo: string; }'/
);
expectSnippet('patchState(state, { count: 10 }, addNumber(10))').toFail(
/Property 'numbers' is missing in type '{ count: number; foo: string; }'/
);
expectSnippet('patchState(state, addNumber(10), { count: 10 })').toFail(
/Property 'numbers' is missing in type '{ count: number; foo: string; }'/
);
expectSnippet('patchState(state, increment(), addNumber(10))').toFail(
/Property 'numbers' is missing in type '{ count: number; foo: string; }'/
);
expectSnippet('patchState(state, addNumber(10), increment())').toFail(
/Property 'numbers' is missing in type '{ count: number; foo: string; }'/
);
const state = signalState({ count: 1, foo: 'bar' });
// @ts-expect-error - PartialStateUpdater<{ numbers: number[]; }> is not assignable to PartialStateUpdater<NoInfer<{ count: number; foo: string; }>>
const test = () => patchState(state, addNumber(10));
// @ts-expect-error - PartialStateUpdater<{ numbers: number[]; }> is not assignable to PartialStateUpdater<NoInfer<{ count: number; foo: string; }>>
const test2 = () => patchState(state, { count: 10 }, addNumber(10));
// @ts-expect-error - PartialStateUpdater<{ numbers: number[]; }> is not assignable to PartialStateUpdater<NoInfer<{ count: number; foo: string; }>>
const test3 = () => patchState(state, addNumber(10), { count: 10 });
// @ts-expect-error - PartialStateUpdater<{ numbers: number[]; }> is not assignable to PartialStateUpdater<NoInfer<{ count: number; foo: string; }>>
const test4 = () => patchState(state, increment(), addNumber(10));
// @ts-expect-error - PartialStateUpdater<{ numbers: number[]; }> is not assignable to PartialStateUpdater<NoInfer<{ count: number; foo: string; }>>
const test5 = () => patchState(state, addNumber(10), increment());
});
}, 8_000);
});
Loading
Loading