• Preparing search index...
  • The search index is not available
Genkit JS API reference
  • Genkit JS API reference
  • genkit
  • /
  • z
  • discriminatedUnion

Function discriminatedUnion

  • discriminatedUnion<
        Discriminator extends string,
        Types extends
            [
                z.ZodDiscriminatedUnionOption<Discriminator>,
                ...z.ZodDiscriminatedUnionOption<Discriminator>[],
            ],
    >(
        discriminator: Discriminator,
        options: Types,
        params?: z.RawCreateParams,
    ): z.ZodDiscriminatedUnion<Discriminator, Types>
  • The constructor of the discriminated union schema. Its behaviour is very similar to that of the normal z.union() constructor. However, it only allows a union of objects, all of which need to share a discriminator property. This property must have a different value for each object in the union.

    Type Parameters

    • Discriminator extends string
    • Types extends [
          z.ZodDiscriminatedUnionOption<Discriminator>,
          ...z.ZodDiscriminatedUnionOption<Discriminator>[],
      ]

    Parameters

    • discriminator: Discriminator

      the name of the discriminator property

    • options: Types
    • Optionalparams: z.RawCreateParams

    Returns z.ZodDiscriminatedUnion<Discriminator, Types>

    • Defined in js/node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:1059

Settings

Member Visibility
Genkit JS API reference
  • Loading...

Generated using TypeDoc with typedoc-github-theme