1 reply

v.optional generates incorrect TypeScript type in api

Michal Srb · 2025-09-12T09:35:42.606Z

This code: ```ts export const foo = query({ args: { bla: v.optional(v.string()), }, handler: async (ctx, args) => {} }); ``` Generates correct type for `foo`: ```ts const foo: RegisteredQuery ``` But the type is incorrect (imprecise) in the api: ```ts foo: FunctionReference ``` Notice that `| undefined` is missing. This is a different type, and it matters when `compilerOptions.exactOptionalPropertyTypes` is set to `true` in tsconfig. I'd guess it's a bug in `Expand` or in TS itself?

This code:

export const foo = query({
  args: {
    bla: v.optional(v.string()),
  },
  handler: async (ctx, args) => {}
});

export const foo = query({
  args: {
    bla: v.optional(v.string()),
  },
  handler: async (ctx, args) => {}
});

export const foo = query({
  args: {
    bla: v.optional(v.string()),
  },
  handler: async (ctx, args) => {}
});

export const foo = query({
  args: {
    bla: v.optional(v.string()),
  },
  handler: async (ctx, args) => {}
});

Generates correct type for

foo

foo

foo

foo:

const foo: RegisteredQuery<"public", {
    bla?: ScopeName | undefined;
}, ....>

const foo: RegisteredQuery<"public", {
    bla?: ScopeName | undefined;
}, ....>

const foo: RegisteredQuery<"public", {
    bla?: ScopeName | undefined;
}, ....>

const foo: RegisteredQuery<"public", {
    bla?: ScopeName | undefined;
}, ....>

But the type is incorrect (imprecise) in the api:

foo: FunctionReference<"query", "public", {
    bla?: ScopeName;
}, ....>

foo: FunctionReference<"query", "public", {
    bla?: ScopeName;
}, ....>

foo: FunctionReference<"query", "public", {
    bla?: ScopeName;
}, ....>

foo: FunctionReference<"query", "public", {
    bla?: ScopeName;
}, ....>

Notice that

| undefined

| undefined

| undefined

| undefined is missing. This is a different type, and it matters when

compilerOptions.exactOptionalPropertyTypes

compilerOptions.exactOptionalPropertyTypes

compilerOptions.exactOptionalPropertyTypes

compilerOptions.exactOptionalPropertyTypes is set to

true

true

true

true in tsconfig.

I'd guess it's a bug in

Expand

Expand

Expand

Expand or in TS itself?

v.optional generates incorrect TypeScript type in api

Similar Threads

Similar Threads

Similar Threads