• Preparing search index...
  • The search index is not available
Solana JavaScript SDK
  • Solana JavaScript SDK
  • @solana/codecs
  • getDiscriminatedUnionEncoder

Function getDiscriminatedUnionEncoder

  • getDiscriminatedUnionEncoder<
        const TVariants extends Variants<Encoder<any>>,
        const TDiscriminatorProperty extends string = "__kind",
    >(
        variants: TVariants,
        config?: DiscriminatedUnionCodecConfig<
            TDiscriminatorProperty,
            NumberEncoder,
        >,
    ): Encoder<GetEncoderTypeFromVariants<TVariants, TDiscriminatorProperty>>
  • Creates a discriminated union encoder.

    Type Parameters

    • const TVariants extends Variants<Encoder<any>>
    • const TDiscriminatorProperty extends string = "__kind"

    Parameters

    • variants: TVariants

      The variant encoders of the discriminated union.

    • Optionalconfig: DiscriminatedUnionCodecConfig<TDiscriminatorProperty, NumberEncoder>

      A set of config for the encoder.

    Returns Encoder<GetEncoderTypeFromVariants<TVariants, TDiscriminatorProperty>>

    • Defined in packages/codecs-data-structures/dist/types/discriminated-union.d.ts:75

Settings

Member Visibility
Solana JavaScript SDK
  • Loading...

Generated using TypeDoc