@walletconnect/encoding

Byte encoding utils

API

1// -- Buffer --------------------------------------------- //
2
3function bufferToUtf8(buf: Buffer): string;
4function bufferToHex(buf: Buffer, prefixed?: boolean): string;
5function bufferToArray(buf: Buffer): Uint8Array;
6function bufferToNumber(buf: Buffer): number;
7function bufferToBinary(buf: Buffer): string;
8
9// -- Utf8 ----------------------------------------------- //
10
11function utf8ToBuffer(utf8: string): Buffer;
12function utf8ToHex(utf8: string, prefixed?: boolean): string;
13function utf8ToArray(utf8: string): Uint8Array;
14function utf8ToNumber(utf8: string): number;
15function utf8ToBinary(utf8: string): string;
16
17// -- Hex ------------------------------------------------ //
18
19function hexToBuffer(hex: string): Buffer;
20function hexToUtf8(hex: string): string;
21function hexToArray(hex: string): Uint8Array;
22function hexToNumber(hex: string): number;
23function hexToBinary(hex: string): string;
24
25// -- Uint8Array ----------------------------------------- //
26
27function arrayToBuffer(arr: Uint8Array): Buffer;
28function arrayToUtf8(arr: Uint8Array): string;
29function arrayToHex(arr: Uint8Array, prefixed?: boolean): string;
30function arrayToNumber(arr: Uint8Array): number;
31function arrayToBinary(arr: Uint8Array): string;
32
33// -- Number ---------------------------------------- //
34
35function numberToBuffer(num: number): Buffer;
36function numberToUtf8(num: number): string;
37function numberToHex(num: number, prefixed?: boolean): string;
38function numberToArray(num: number): Uint8Array;
39function numberToBinary(num: number): string;
40
41// -- Binary ----------------------------------------------- //
42
43function binaryToBuffer(bin: string): Buffer;
44function binaryToArray(bin: string): Uint8Array;
45function binaryToHex(bin: string | string, prefixed?: boolean): string;
46function binaryToUtf8(bin: string): string;
47function binaryToNumber(bin: string): number;
48
49// -- Validators ----------------------------------------- //
50
51function isBinaryString(str: any): boolean;
52function isHexString(str: any, length?: number): boolean;
53function isBuffer(val: any): boolean;
54function isTypedArray(val: any): boolean;
55function isArrayBuffer(val: any): boolean;
56
57function getType(val: any);
58function getEncoding(str: string);
59
60// -- Misc ----------------------------------------------- //
61
62function concatBuffers(...args: Buffer[]): Buffer;
63function concatArrays(...args: Uint8Array[]): Uint8Array;
64function trimLeft(data: Buffer, length: number): Buffer;
65function trimRight(data: Buffer, length: number): Buffer;
66
67function calcByteLength(length: number, byteSize: number): number;
68function splitBytes(str: string, byteSize: number): string[];
69function sanitizeBytes(str: string, byteSize: number, padding: string): string;
70function swapBytes(str: string): string;
71function swapHex(str: string): string;
72
73function padLeft(str: string, length: number, padding?: string): string;
74function padRight(str: string, length: number, padding?: string): string;
75
76function removeHexPrefix(hex: string): string;
77function addHexPrefix(hex: string): string;
78function sanitizeHex(hex: string): string;
79function removeHexLeadingZeros(hex: string): string;