• Preparing search index...
  • The search index is not available
Solana JavaScript SDK
  • Solana JavaScript SDK
  • @solana/web3.js
  • getMapCodec

Function getMapCodec

  • getMapCodec<TFromKey, TFromValue, TToKey = TFromKey, TToValue = TFromValue>(
        key: Codec<TFromKey, TToKey>,
        value: Codec<TFromValue, TToValue>,
        config: MapCodecConfig<NumberCodec> & { size: 0 },
    ): FixedSizeCodec<Map<TFromKey, TFromValue>, Map<TToKey, TToValue>, 0>
  • Creates a codec for a map.

    Type Parameters

    • TFromKey
    • TFromValue
    • TToKey = TFromKey
    • TToValue = TFromValue

    Parameters

    • key: Codec<TFromKey, TToKey>

      The codec to use for the map's keys.

    • value: Codec<TFromValue, TToValue>

      The codec to use for the map's values.

    • config: MapCodecConfig<NumberCodec> & { size: 0 }

      A set of config for the codec.

    Returns FixedSizeCodec<Map<TFromKey, TFromValue>, Map<TToKey, TToValue>, 0>

    • Defined in packages/codecs-data-structures/dist/types/map.d.ts:47
  • getMapCodec<TFromKey, TFromValue, TToKey = TFromKey, TToValue = TFromValue>(
        key: FixedSizeCodec<TFromKey, TToKey>,
        value: FixedSizeCodec<TFromValue, TToValue>,
        config: MapCodecConfig<NumberCodec> & { size: number },
    ): FixedSizeCodec<Map<TFromKey, TFromValue>, Map<TToKey, TToValue>>
  • Creates a codec for a map.

    Type Parameters

    • TFromKey
    • TFromValue
    • TToKey = TFromKey
    • TToValue = TFromValue

    Parameters

    • key: FixedSizeCodec<TFromKey, TToKey>

      The codec to use for the map's keys.

    • value: FixedSizeCodec<TFromValue, TToValue>

      The codec to use for the map's values.

    • config: MapCodecConfig<NumberCodec> & { size: number }

      A set of config for the codec.

    Returns FixedSizeCodec<Map<TFromKey, TFromValue>, Map<TToKey, TToValue>>

    • Defined in packages/codecs-data-structures/dist/types/map.d.ts:50
  • getMapCodec<TFromKey, TFromValue, TToKey = TFromKey, TToValue = TFromValue>(
        key: Codec<TFromKey, TToKey>,
        value: Codec<TFromValue, TToValue>,
        config?: MapCodecConfig<NumberCodec>,
    ): VariableSizeCodec<Map<TFromKey, TFromValue>, Map<TToKey, TToValue>>
  • Creates a codec for a map.

    Type Parameters

    • TFromKey
    • TFromValue
    • TToKey = TFromKey
    • TToValue = TFromValue

    Parameters

    • key: Codec<TFromKey, TToKey>

      The codec to use for the map's keys.

    • value: Codec<TFromValue, TToValue>

      The codec to use for the map's values.

    • Optionalconfig: MapCodecConfig<NumberCodec>

      A set of config for the codec.

    Returns VariableSizeCodec<Map<TFromKey, TFromValue>, Map<TToKey, TToValue>>

    • Defined in packages/codecs-data-structures/dist/types/map.d.ts:53

Settings

Member Visibility
Solana JavaScript SDK
  • Loading...

Generated using TypeDoc