Skip to content

Accept readonly issues in flatten #1269

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Accept readonly issues in flatten #1269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions library/src/methods/flatten/flatten.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,15 @@ describe('flatten', () => {
readonly other?: [string, ...string[]];
}>();
});

test('should accept readonly list of errors', () => {
const readonlyIssues = issues as Readonly<typeof issues>;
expectTypeOf(flatten(readonlyIssues)).toEqualTypeOf<{
readonly root?: [string, ...string[]];
readonly nested?: Readonly<
Partial<Record<string, [string, ...string[]]>>
>;
readonly other?: [string, ...string[]];
}>();
});
});
6 changes: 3 additions & 3 deletions library/src/methods/flatten/flatten.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export type FlatErrors<
* @returns A flat error object.
*/
export function flatten(
issues: [BaseIssue<unknown>, ...BaseIssue<unknown>[]]
issues: readonly [BaseIssue<unknown>, ...BaseIssue<unknown>[]]
): FlatErrors<undefined>;

/**
Expand All @@ -77,11 +77,11 @@ export function flatten<
TSchema extends
| BaseSchema<unknown, unknown, BaseIssue<unknown>>
| BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
>(issues: [InferIssue<TSchema>, ...InferIssue<TSchema>[]]): FlatErrors<TSchema>;
>(issues: readonly [InferIssue<TSchema>, ...InferIssue<TSchema>[]]): FlatErrors<TSchema>;

// @__NO_SIDE_EFFECTS__
export function flatten(
issues: [BaseIssue<unknown>, ...BaseIssue<unknown>[]]
issues: readonly [BaseIssue<unknown>, ...BaseIssue<unknown>[]]
): FlatErrors<undefined> {
// Create flat errors object
const flatErrors: FlatErrors<undefined> = {};
Expand Down