Zod Entry using standard encryption key

Question

Zod Entry using standard encryption key

I'm attempting to define an object type in zod that looks like this:

{
    default: string,
    [string]: string,
}

I've experimented with combining z.object and z.record using z.union, but the validation results are not as expected.

const LocaleString = z.union([
  z
    .object({
      default: z.string(),
    }).required(),
  z.record(z.string()),
]);

LocaleString.safeParse({
  testing: 'abc',
}); 
/** 
* it will return `{ success: true, data: { testing: 'abc' } }`, 
* where I expect it to fail when the data is without a default value
*/

typescript zod

Answer 1

Answer №1

After some investigation, I discovered a solution that worked perfectly in my situation.

const LanguageStrings = z.object({
  default: z.string(),
}).and(z.record(z.string()));

LanguageStrings.safeParse({
  default: '123',
}); // passes successfully

LanguageStrings.safeParse({
  en: '123',
}); // fails to pass

LanguageStrings.safeParse({}); // fails to pass

LanguageStrings.safeParse({
  default: 'abc',
  en: 'def',
}); // passes successfully

Answer 2

After some investigation, I discovered a solution that worked perfectly in my situation.

const LanguageStrings = z.object({
  default: z.string(),
}).and(z.record(z.string()));

LanguageStrings.safeParse({
  default: '123',
}); // passes successfully

LanguageStrings.safeParse({
  en: '123',
}); // fails to pass

LanguageStrings.safeParse({}); // fails to pass

LanguageStrings.safeParse({
  default: 'abc',
  en: 'def',
}); // passes successfully

Answer 3

Answer №2

If you want to avoid strict validation, you can modify the object.

Sample Schema:

z.object({
  default: z.string()
})

Data:

{
  default: 'circle',
  example: true
}

Outcome:

Validation Passed

Data:

{
  example: true
}

Outcome:

Validation errors: 
[
  { path: "default", error: "Required" },
]

By applying .strict() to the object() definition, the initial data will not pass validation.

Sample Schema:

z.object({
  default: z.string()
}).strict()

Data:

{
  default: 'circle',
  example: true
}

Outcome:

Validation errors: 
[
  { error: "Unrecognized key(s) in object: 'example'" },
]

Answer 4

If you want to avoid strict validation, you can modify the object.

Sample Schema:

z.object({
  default: z.string()
})

Data:

{
  default: 'circle',
  example: true
}

Outcome:

Validation Passed

Data:

{
  example: true
}

Outcome:

Validation errors: 
[
  { path: "default", error: "Required" },
]

By applying .strict() to the object() definition, the initial data will not pass validation.

Sample Schema:

z.object({
  default: z.string()
}).strict()

Data:

{
  default: 'circle',
  example: true
}

Outcome:

Validation errors: 
[
  { error: "Unrecognized key(s) in object: 'example'" },
]

Zod Entry using standard encryption key

Answer №1

Answer №2

Similar questions

The classification of a property is determined by the types of the other properties present

Leveraging Angular2's observable stream in combination with *ngFor

Facing issues with module resolution while attempting to debug in VSCode

Implementing Typescript for managing state in React components

Enhancing JavaScript functions with type definitions

How can I display the values stored in an array of objects in Angular 2

The type '{}' is lacking the specified attributes from type 'RouteComponentProps<{},,>'

The attribute 'location' is not found in the 'File' data type

When accessing the innerHTML and outerHTML properties on an HTMLElement, they may return undefined without triggering

3 Ways to Ensure Your Picture Uploads are Visible Right Away

When declaring an array of numbers in sequelize-typescript, it triggers a TypeScript error

Tips for managing errors when utilizing pipe and mergemap in Angular

I am having trouble accessing my JSON data via HTTP get request in Angular 2 when using TypeScript

Implementing debounce in Subject within rxjs/Angular2

What is the reason behind Webpack's behavior of loading all files from a folder during lazy loading

Collaborate and reuse Typescript code across various Node projects

Troubleshooting Issue with Mongoose Virtual Field Population

Tips for choosing a subset of objects within a larger array of objects and generating a new array from them?

Utilize Angular's $state service within a configuration setting to automatically redirect to a specific state using an interceptor

Ways to obtain a tab and designate it as the default in angular when using angular material Tabs