Guide on creating a zodiac validator that specifically handles properties with inferred types of number or undefined

Question

Guide on creating a zodiac validator that specifically handles properties with inferred types of number or undefined

There are some predefined definitions for an API (with types generated using protocol buffers). I prefer not to modify these.

One of the types, which we'll refer to as SomeInterfaceOutOfMyControl, includes a property that is a union type of undefined. Here's how it looks:

interface SomeInterfaceOutOfMyControl {
    someProperty: number | undefined
}

function someFuncOutOfMyControl(obj: SomeInterfaceOutOfMyControl) {}

I am attempting to create a validator to ensure that the data adheres to the correct format. For this purpose, I am utilizing zod.

const validator = z.object({
    someProperty: z.optional(z.number()),
})

However, the TypeScript compiler seems to be confused about the fact that number | undefined is essentially the same as an optional property. Hence, I encounter this compiler error:

error TS2322: Type '{ someProperty?: number | undefined; }' is not assignable to type 'SomeInterfaceOutOfMyControl'. Property 'someProperty' is optional in type '{ someProperty?: number | undefined; }' but required in type 'SomeInterfaceOutOfMyControl'.

const object: SomeInterfaceOutOfMyControl = validator.parse(someData)

const validator = z.object({
    someProperty: z.union([z.number(), z.undefined()]),
})
const someData = {} as any
const object = validator.parse(someData)

someFuncOutOfMyControl(object)
// Error on the line above:
// Argument of type '{ someProperty?: number | undefined; }' is not assignable to parameter of type 'SomeInterfaceOutOfMyControl'.
// Property 'someProperty' is optional in type '{ someProperty?: number | undefined; }' but required in type 'SomeInterfaceOutOfMyControl'.

How can I adjust the zod validation so that the inferred type aligns with the interface correctly? In other words, how do I create a validator for this?:

interface SomeInterfaceOutOfMyControl {
    someProperty: number | undefined
}

I attempted using a union:

const validator = z.object({
    someProperty: z.union([z.number(), z.undefined()]),
})

However, the outcome remains the same...

typescript protocol-buffers zod

Answer 1

Answer №1

Here's a creative workaround I came up with to address the issue at hand. It may not be directly applicable to your specific scenario, but I believe it's worth sharing.

Given the limitation of not being able to modify SomeInterfaceOutOfMyControl,

You can extend it and define optional fields using Partial. Here's how:

interface SomeInterfaceOutOfMyControl {
  someProperty: number | undefined;
}

type MyInterface = Partial<SomeInterfaceOutOfMyControl>;

const validator: z.ZodType<MyInterface> = z.object({
  someProperty: z.union([z.number(), z.undefined()]),
});

const someData = {} as any;

const object: MyInterface = validator.parse(someData);

Answer 2

Here's a creative workaround I came up with to address the issue at hand. It may not be directly applicable to your specific scenario, but I believe it's worth sharing.

Given the limitation of not being able to modify SomeInterfaceOutOfMyControl,

You can extend it and define optional fields using Partial. Here's how:

interface SomeInterfaceOutOfMyControl {
  someProperty: number | undefined;
}

type MyInterface = Partial<SomeInterfaceOutOfMyControl>;

const validator: z.ZodType<MyInterface> = z.object({
  someProperty: z.union([z.number(), z.undefined()]),
});

const someData = {} as any;

const object: MyInterface = validator.parse(someData);

Answer 3

Answer №2

Are you considering making a modification to the schema as a potential solution:

import {z} from "zod"
interface SomeInterfaceOutOfMyControl {
    someProperty: number | undefined
}

function someFuncOutOfMyControl(obj: SomeInterfaceOutOfMyControl) {}

const validator = z.object({
    someProperty: z.number().optional(),
}).transform(o => ({...o, someProperty: o.someProperty }))

const someData = {} as unknown
const object: SomeInterfaceOutOfMyControl = validator.parse(someData)
someFuncOutOfMyControl(object)

Answer 4

Are you considering making a modification to the schema as a potential solution:

import {z} from "zod"
interface SomeInterfaceOutOfMyControl {
    someProperty: number | undefined
}

function someFuncOutOfMyControl(obj: SomeInterfaceOutOfMyControl) {}

const validator = z.object({
    someProperty: z.number().optional(),
}).transform(o => ({...o, someProperty: o.someProperty }))

const someData = {} as unknown
const object: SomeInterfaceOutOfMyControl = validator.parse(someData)
someFuncOutOfMyControl(object)

Guide on creating a zodiac validator that specifically handles properties with inferred types of number or undefined

Answer №1

Answer №2

Similar questions

How can Firebase and Ionic be used to customize the password reset template for sending verification emails and more?

Acquire keys from a different residence

Managing Observable<Person[]> in ng-bootstrap typeahead instead of Observable<string[]>: a complete guide

Incorrectly asserting the data type of a union

Finding the number of elements in a FirebaseListObservable involves accessing the `length` property

Code coverage analysis in a node.js TypeScript project consistently shows no coverage metrics

Ionic: Fixed button located at the bottom of a specific ion-slide

What are the properties used in functional components of React?

JavaScript alert box

The struggle of accessing child components using ViewChild in Angular

Is there a way to receive a comprehensive report in case the deletion process encounters an error?

How can methods from another class be accessed in a TypeScript constructor?

Please explain the purpose of the httponly ss-tok bearerToken cookie in ServiceStack Authentication

Accessing JSON data stored locally and initializing it into a TypeScript variable within a React application

The Authorization header in POST and PATCH fetch requests is stripped by Typescript

Encountering issue with FullCalendar and Angular 11: Error reading property '__k' of null

Showing elapsed time similar to YouTube in an Angular 8 application

Guide to locating a particular node within an array of nested objects by utilizing the object

Error with Angular 2 observables in TypeScript

Can you input a string into a generic in TypeScript and subsequently utilize it as a type/interface key?