Skip to content
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

show helpful error message when non-defined keys are passed after def… #900

Closed
wants to merge 2 commits into from
Closed

show helpful error message when non-defined keys are passed after def… #900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22c7ef1
show helpful error message when non-defined keys are passed after def…
noyan-alimov Jan 30, 2022
095d6e3
coverage svg
noyan-alimov Jan 30, 2022
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
2 changes: 1 addition & 1 deletion coverage.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions deno/lib/__tests__/pickomit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,12 @@ test("nonstrict parsing - fail", () => {
const bad = () => laxfish.parse({ whatever: "asdf" } as any);
expect(bad).toThrow();
});

test("pick - non-defined key", () => {
const bad = () => fish.pick({ name: true, color: true });
expect(bad).toThrow(
new Error(
"color key does not exist in object schema. Available keys: name,age,nested"
)
);
});
8 changes: 8 additions & 0 deletions deno/lib/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1659,6 +1659,14 @@ export class ZodObject<
util.objectKeys(mask).map((key) => {
shape[key] = this.shape[key];
});
util.objectKeys(shape).map((key) => {
if (!shape[key])
throw new Error(
`${key} key does not exist in object schema. Available keys: ${util.objectKeys(
this.shape
)}`
);
});
return new ZodObject({
...this._def,
shape: () => shape,
Expand Down
9 changes: 9 additions & 0 deletions src/__tests__/pickomit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,12 @@ test("nonstrict parsing - fail", () => {
const bad = () => laxfish.parse({ whatever: "asdf" } as any);
expect(bad).toThrow();
});

test("pick - non-defined key", () => {
const bad = () => fish.pick({ name: true, color: true });
expect(bad).toThrow(
new Error(
"color key does not exist in object schema. Available keys: name,age,nested"
)
);
});
8 changes: 8 additions & 0 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1659,6 +1659,14 @@ export class ZodObject<
util.objectKeys(mask).map((key) => {
shape[key] = this.shape[key];
});
util.objectKeys(shape).map((key) => {
if (!shape[key])
throw new Error(
`${key} key does not exist in object schema. Available keys: ${util.objectKeys(
this.shape
)}`
);
});
return new ZodObject({
...this._def,
shape: () => shape,
Expand Down