diff options
Diffstat (limited to 'vanilla/node_modules/@exodus/bytes/hex.d.ts')
| -rw-r--r-- | vanilla/node_modules/@exodus/bytes/hex.d.ts | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/vanilla/node_modules/@exodus/bytes/hex.d.ts b/vanilla/node_modules/@exodus/bytes/hex.d.ts new file mode 100644 index 0000000..dbd29e6 --- /dev/null +++ b/vanilla/node_modules/@exodus/bytes/hex.d.ts @@ -0,0 +1,35 @@ +/** + * Implements Base16 from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648) + * (no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)). + * + * ```js + * import { fromHex, toHex } from '@exodus/bytes/hex.js' + * ``` + * + * @module @exodus/bytes/hex.js + */ + +/// <reference types="node" /> + +import type { OutputFormat, Uint8ArrayBuffer } from './array.js'; + +/** + * Encode a `Uint8Array` to a lowercase hex string + * + * @param arr - The input bytes + * @returns The hex encoded string + */ +export function toHex(arr: Uint8Array): string; + +/** + * Decode a hex string to bytes + * + * Unlike `Buffer.from()`, throws on invalid input + * + * @param string - The hex encoded string (case-insensitive) + * @param format - Output format (default: 'uint8') + * @returns The decoded bytes + */ +export function fromHex(string: string, format?: 'uint8'): Uint8ArrayBuffer; +export function fromHex(string: string, format: 'buffer'): Buffer; +export function fromHex(string: string, format?: OutputFormat): Uint8ArrayBuffer | Buffer; |
