Documentation
    Preparing search index...

    Class BcsTuple<T, Name>

    BcsType for a fixed-length heterogeneous tuple.

    Type Parameters

    • const T extends readonly BcsType<any>[]
    • const Name extends string = `(${JoinString<
          { [K in keyof T]: T[K] extends BcsType<any, any, infer T> ? T : never },
          ", ",
      >})`

    Hierarchy (View Summary)

    • BcsType<
          {
              -readonly [K in keyof T]: T[K] extends BcsType<infer T, any>
                  ? T
                  : never
          },
          { [K in keyof T]: T[K] extends BcsType<any, infer T> ? T : never },
          Name,
      >
      • BcsTuple
    Index

    Constructors

    constructor

    Properties

    _codec $inferInput $inferType name serialize serializedSize validate

    Methods

    fromBase58 fromBase64 fromHex parse read toBase58 toBase64 toBytes toHex transform write

    Constructors

    • Type Parameters

      • const T extends readonly BcsType<any, any, string>[]
      • const Name extends string = `(${JoinString<
            {
                [K in string
                | number
                | symbol]: T[K] extends BcsType<any, any, T> ? T : never
            },
            ", ",
        >})`

      Parameters

      • __namedParameters: BcsTupleOptions<T, Name>

      Returns BcsTuple<T, Name>

    Properties

    _codec

    _codec: {
        kind?: string;
        read: () => {
            -readonly [K in string
            | number
            | symbol]: T[K] extends BcsType<T, any, string> ? T : never
        };
        write: (
            value: {
                [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                    ? T
                    : never
            },
        ) => void;
    }

    Internal codec holding the fast read/write closures and an optional kind tag used by bulk encoder/decoder dispatch.

    $inferInput: {
        [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
            ? T
            : never
    }
    $inferType: {
        -readonly [K in string | number | symbol]: T[K] extends BcsType<
            T,
            any,
            string,
        >
            ? T
            : never
    }
    name: Name
    serialize: (
        value: {
            [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                ? T
                : never
        },
        options?: BcsWriterOptions,
    ) => SerializedBcs<
        {
            -readonly [K in string
            | number
            | symbol]: T[K] extends BcsType<T, any, string> ? T : never
        },
        {
            [K in string
            | number
            | symbol]: T[K] extends BcsType<any, T, string> ? T : never
        },
    >
    serializedSize: (
        value: {
            [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                ? T
                : never
        },
        options?: BcsWriterOptions,
    ) => number | null
    validate: (
        value: {
            [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                ? T
                : never
        },
    ) => void

    Methods

    • Parameters

      • b58: string

      Returns {
          -readonly [K in string | number | symbol]: T[K] extends BcsType<
              T,
              any,
              string,
          >
              ? T
              : never
      }

    • Parameters

      • b64: string

      Returns {
          -readonly [K in string | number | symbol]: T[K] extends BcsType<
              T,
              any,
              string,
          >
              ? T
              : never
      }

    • Parameters

      • hex: string

      Returns {
          -readonly [K in string | number | symbol]: T[K] extends BcsType<
              T,
              any,
              string,
          >
              ? T
              : never
      }

    • Parameters

      • bytes: Uint8Array

      Returns {
          -readonly [K in string | number | symbol]: T[K] extends BcsType<
              T,
              any,
              string,
          >
              ? T
              : never
      }

    • Decode from a BcsReader. Syncs the singleton decoder to the reader's state, runs the fast decode path, then syncs the position back. For the common case, use parse() instead.

      Parameters

      Returns {
          -readonly [K in string | number | symbol]: T[K] extends BcsType<
              T,
              any,
              string,
          >
              ? T
              : never
      }

    • Parameters

      • value: {
            [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                ? T
                : never
        }

      Returns string

    • Parameters

      • value: {
            [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                ? T
                : never
        }

      Returns string

    • Parameters

      • value: {
            [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                ? T
                : never
        }

      Returns Uint8Array<ArrayBuffer>

    • Parameters

      • value: {
            [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                ? T
                : never
        }

      Returns string

    • Type Parameters

      • T2 = {
            -readonly [K in string | number | symbol]: T[K] extends BcsType<
                T,
                any,
                string,
            >
                ? T
                : never
        }
      • Input2 = {
            [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                ? T
                : never
        }
      • NewName extends string = Name

      Parameters

      • __namedParameters: {
            input?: (
                val: Input2,
            ) => {
                [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                    ? T
                    : never
            };
            output?: (
                value: {
                    -readonly [K in string | number | symbol]: T[K] extends BcsType<
                        T,
                        any,
                        string,
                    >
                        ? T
                        : never
                },
            ) => T2;
        } & BcsTypeOptions<T2, Input2, NewName>

      Returns BcsType<T2, Input2, NewName>

    • Parameters

      • value: {
            [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                ? T
                : never
        }
      • Optional_writer: BcsWriter

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods