@polkadot/types-codec
Version:
Implementation of the SCALE codec
38 lines (37 loc) • 1.36 kB
TypeScript
import type { AnyU8a, Inspect, Registry } from '../types/index.js';
import { Raw } from '../native/Raw.js';
/**
* @name BitVec
* @description
* A BitVec that represents an array of bits. The bits are however stored encoded. The difference between this
* and a normal Bytes would be that the length prefix indicates the number of bits encoded, not the bytes
*/
export declare class BitVec extends Raw {
#private;
constructor(registry: Registry, value?: AnyU8a, isMsb?: boolean);
/**
* @description The length of the value when encoded as a Uint8Array
*/
get encodedLength(): number;
/**
* @description Returns a breakdown of the hex encoding for this Codec
*/
inspect(): Inspect;
/**
* @description Creates a boolean array of the bit values
*/
toBoolArray(): boolean[];
/**
* @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
*/
toHuman(): string;
/**
* @description Returns the base runtime type name for this instance
*/
toRawType(): string;
/**
* @description Encodes the value as a Uint8Array as per the SCALE specifications
* @param isBare true when the value has none of the type-specific prefixes (internal)
*/
toU8a(isBare?: boolean): Uint8Array;
}