Force typeing on object schema

[kenhuang]

In zod we can do this:

type Test {
  field1?: string,
  field2?: string,
}

const TestSchema: z.ZodType<Test> = z.object({
  field1: z.string().optional(),
  field2: z.string().optional(),
});

Is anything similar in valibot? Thanks for the awsome library!

[fabian-hiller]

Yes, please try out BaseSchema:

import * as v from 'valibot';

type Test {
  field1?: string,
  field2?: string,
}

const TestSchema: v.BaseSchema<Test> = v.object({
  field1: v.optional(v.string()),
  field2: v.optional(v.string()),
});

[fabian-hiller]

Hint: Sometimes satisfies is better to not lose type safety for specific object related information:

import * as v from 'valibot';

type Test = {
  field1?: string,
  field2?: string,
}

const TestSchema = v.object({
  field1: v.optional(v.string()),
  field2: v.optional(v.string()),
}) satisfies v.BaseSchema<Test>;

[NagRock]

Hey @fabian-hiller,

Base schema requires 3 generics arguments, so the provided example doesnt work.

[fabian-hiller]

Since we rewrote the whole library with v0.31.0, our implementation changed a bit. Just change BaseSchema to GenericSchema.

• https://valibot.dev/blog/valibot-v0.31.0-is-finally-available/
• https://valibot.dev/guides/migrate-to-v0.31.0/

import * as v from 'valibot';

type Test = {
  field1?: string,
  field2?: string,
}

const TestSchema = v.object({
  field1: v.optional(v.string()),
  field2: v.optional(v.string()),
}) satisfies v.GenericSchema<Test>;

[NagRock]

Thanks, I will give a try.