6 replies

union kind

https://docs.convex.dev/database/schemas#unions

example from the docs

defineTable(
  v.union(
    v.object({
      kind: v.literal("StringDocument"),
      value: v.string(),
    }),
    v.object({
      kind: v.literal("NumberDocument"),
      value: v.number(),
    })
  )
);

defineTable(
  v.union(
    v.object({
      kind: v.literal("StringDocument"),
      value: v.string(),
    }),
    v.object({
      kind: v.literal("NumberDocument"),
      value: v.number(),
    })
  )
);

in this example I wonder if

value

value

can be a

v.object

v.object

instead of

v.string

v.string

and

v.number

v.number

.

I also wonder if the

kind

kind

field has to be always named

kind

kind

or can it be also

tag

tag

?

I'm exploring how to map this to Rescript Variants

I would like to do something like this

let jobWindow = {
  width: v.number(),
  height: v.number()
}
let jobProduct = {
  qty: v.number(),
  name: v.string()
}
defineTable({
 v.union(
    v.object({
      tag: v.literal("JobWindow"),
      value: jobWindow,
    }),
    v.object({
      tag: v.literal("JobProduct"),
      value: jobProduct,
    })
  )
});

let jobWindow = {
  width: v.number(),
  height: v.number()
}
let jobProduct = {
  qty: v.number(),
  name: v.string()
}
defineTable({
 v.union(
    v.object({
      tag: v.literal("JobWindow"),
      value: jobWindow,
    }),
    v.object({
      tag: v.literal("JobProduct"),
      value: jobProduct,
    })
  )
});

Schemas | Convex Developer Hub

Schema validation keeps your Convex data neat and tidy. It also gives you end-to-end TypeScript type safety!

union kind

Similar Threads