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

Function getLiteralUnionDecoder

  • getLiteralUnionDecoder<const TVariants extends readonly Variant[]>(
        variants: TVariants,
    ): FixedSizeDecoder<GetTypeFromVariants<TVariants>, 1>
  • Creates a literal union decoder.

    Type Parameters

    • const TVariants extends readonly Variant[]

    Parameters

    • variants: TVariants

      The variant decoders of the literal union.

    Returns FixedSizeDecoder<GetTypeFromVariants<TVariants>, 1>

    • Defined in packages/codecs-data-structures/dist/types/literal-union.d.ts:30
  • getLiteralUnionDecoder<
        const TVariants extends readonly Variant[],
        TSize extends number,
    >(
        variants: TVariants,
        config: LiteralUnionCodecConfig<NumberDecoder> & {
            size: FixedSizeNumberDecoder<TSize>;
        },
    ): FixedSizeDecoder<GetTypeFromVariants<TVariants>, TSize>
  • Creates a literal union decoder.

    Type Parameters

    • const TVariants extends readonly Variant[]
    • TSize extends number

    Parameters

    • variants: TVariants

      The variant decoders of the literal union.

    • config: LiteralUnionCodecConfig<NumberDecoder> & { size: FixedSizeNumberDecoder<TSize> }

      A set of config for the decoder.

    Returns FixedSizeDecoder<GetTypeFromVariants<TVariants>, TSize>

    • Defined in packages/codecs-data-structures/dist/types/literal-union.d.ts:31
  • getLiteralUnionDecoder<const TVariants extends readonly Variant[]>(
        variants: TVariants,
        config?: LiteralUnionCodecConfig<NumberDecoder>,
    ): VariableSizeDecoder<GetTypeFromVariants<TVariants>>
  • Creates a literal union decoder.

    Type Parameters

    • const TVariants extends readonly Variant[]

    Parameters

    • variants: TVariants

      The variant decoders of the literal union.

    • Optionalconfig: LiteralUnionCodecConfig<NumberDecoder>

      A set of config for the decoder.

    Returns VariableSizeDecoder<GetTypeFromVariants<TVariants>>

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

Settings

Member Visibility
Solana JavaScript SDK
  • Loading...

Generated using TypeDoc