Class BcsType<T, Input, Name>

constructor

• new BcsType<T, Input = T, const Name extends string = string>(
      options: {
          kind?: string;
          name: Name;
          read: ((reader: BcsReader) => T) | (() => T);
          serialize?: (value: Input) => Uint8Array<ArrayBuffer>;
          serializedSize?: (value: Input) => number | null;
          validate?: (value: Input) => void;
          write:
              | ((value: Input, writer: BcsWriter) => void)
              | ((value: Input) => void);
      } & BcsTypeOptions<T, Input, Name>,
  ): BcsType<T, Input, Name>

  Type Parameters

  • T
  • Input = T
  • const Name extends string = string

  Parameters

  • options: {
        kind?: string;
        name: Name;
        read: ((reader: BcsReader) => T) | (() => T);
        serialize?: (value: Input) => Uint8Array<ArrayBuffer>;
        serializedSize?: (value: Input) => number | null;
        validate?: (value: Input) => void;
        write:
            | ((value: Input, writer: BcsWriter) => void)
            | ((value: Input) => void);
    } & BcsTypeOptions<T, Input, Name>

  Returns BcsType<T, Input, Name>

_codec

$inferInput

$inferType

name

serialize

serializedSize

validate

fromBase58

• fromBase58(b58: string): T

  Parameters

  • b58: string

  Returns T

fromBase64

• fromBase64(b64: string): T

  Parameters

  • b64: string

  Returns T

fromHex

• fromHex(hex: string): T

  Parameters

  • hex: string

  Returns T

parse

• parse(bytes: Uint8Array): T

  Parameters

  • bytes: Uint8Array

  Returns T

read

• read(reader: BcsReader): T

  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

  • reader: BcsReader

  Returns T

toBase58

• toBase58(value: Input): string

  Parameters

  • value: Input

  Returns string

toBase64

• toBase64(value: Input): string

  Parameters

  • value: Input

  Returns string

toBytes

• toBytes(value: Input): Uint8Array<ArrayBuffer>

  Parameters

  • value: Input

  Returns Uint8Array<ArrayBuffer>

toHex

• toHex(value: Input): string

  Parameters

  • value: Input

  Returns string

transform

• transform<T2 = T, Input2 = Input, NewName extends string = Name>(
      __namedParameters: {
          input?: (val: Input2) => Input;
          output?: (value: T) => T2;
      } & BcsTypeOptions<T2, Input2, NewName>,
  ): BcsType<T2, Input2, NewName>

  Type Parameters

  • T2 = T
  • Input2 = Input
  • NewName extends string = Name

  Parameters

  • __namedParameters: { input?: (val: Input2) => Input; output?: (value: T) => T2 } & BcsTypeOptions<
        T2,
        Input2,
        NewName,
    >

  Returns BcsType<T2, Input2, NewName>

write

• write(value: Input, _writer?: BcsWriter): void

  Parameters

  • value: Input
  • Optional_writer: BcsWriter

  Returns void