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) => {}
});

Generates correct type for foofoo:

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;
}, ....>

Notice that | undefined| undefined is missing. This is a different type, and it matters when compilerOptions.exactOptionalPropertyTypescompilerOptions.exactOptionalPropertyTypes is set to truetrue in tsconfig.

I'd guess it's a bug in ExpandExpand or in TS itself?

Convex Community•8mo ago•

1 reply

Michal Srb

v.optional generates incorrect TypeScript type in api

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) => {}
});

Generates correct type for foofoo:

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;
}, ....>

Continue the conversation

Join the Discord to ask follow-up questions and connect with the community

Convex Community

Join the Convex Discord! Explore Convex, the backend platform that keeps your app in sync.

15,960 Members

Join

v.optional generates incorrect TypeScript type in api

v.optional generates incorrect TypeScript type in api

Continue the conversation

Convex Community

Continue the conversation

Convex Community

Similar Threads