@xylabs/hex 3.0.11 → 3.0.13

package/src/hex/from/fromNumber.ts

@@ -0,0 +1,6 @@
+import { Hex, HexConfig } from '../model'
+import { hexFromBigInt } from './fromBigInt'
+
+export const hexFromNumber = (value: number, config?: HexConfig): Hex => {
+  return hexFromBigInt(BigInt(value), config)
+}

package/src/hex/from/index.ts

@@ -1,2 +1,5 @@
 export * from './from'
+export * from './fromArrayBuffer'
+export * from './fromBigInt'
 export * from './fromHexString'
+export * from './fromNumber'

package/src/hex/index.ts

@@ -6,3 +6,4 @@ export * from './legacy'
 export * from './model'
 export * from './nibble'
 export * from './regex'
+export * from './to'

package/src/hex/legacy.ts

@@ -1,8 +1,3 @@
 export const toHexLegacy = (buffer: ArrayBuffer) => {
   return [...new Uint8Array(buffer)].map((x) => x.toString(16).padStart(2, '0')).join('')
 }
-
-/** @deprecated use toHexLegacy instead */
-export const toHex = (buffer: ArrayBuffer) => {
-  return toHexLegacy(buffer)
-}

package/src/hex/model.ts

@@ -1,6 +1,7 @@
 //we use Exclude to intentionally make the type not equal to string
 export type Hex = Exclude<Lowercase<string>, 'reserved-hex-value'>
 
+/** Configuration of validation and output format */
 export interface HexConfig {
   bitLength?: number
   byteSize?: number

package/src/hex/to.ts

@@ -0,0 +1,13 @@
+import { hexFrom } from './from'
+import { HexConfig } from './model'
+
+/** takes any value and tries our best to convert it to a hex string */
+export const toHex = (
+  /** Supported types are string, number, bigint, and ArrayBuffer */
+  value: unknown,
+  /** Configuration of output format and validation */
+  config: HexConfig = {},
+) => {
+  const { prefix = false } = config
+  return hexFrom(value, { prefix, ...config })
+}