@ocap/util 1.27.16 → 1.28.0

package/lib/index.d.ts

@@ -1,22 +1,23 @@
-import type { LiteralUnion } from 'type-fest';
-import rightPad from 'lodash/padEnd';
-import leftPad from 'lodash/padStart';
-import { BN } from './bn';
-export declare const isBase58btc: (data: any) => boolean;
-export type BytesType = string | Buffer | Uint8Array;
-export type EncodingType = LiteralUnion<'hex' | 'base16' | 'base58' | 'base64' | 'Uint8Array' | 'buffer', string>;
-export type KeyPairType = {
-    publicKey: BytesType;
-    secretKey: BytesType;
+import { BN } from "./bn.js";
+import { LiteralUnion } from "type-fest";
+import rightPad from "lodash/padEnd";
+import leftPad from "lodash/padStart";
+
+//#region src/index.d.ts
+declare const isBase58btc: (data: any) => boolean;
+type BytesType = string | Buffer | Uint8Array;
+type EncodingType = LiteralUnion<'hex' | 'base16' | 'base58' | 'base64' | 'Uint8Array' | 'buffer', string>;
+type KeyPairType = {
+  publicKey: BytesType;
+  secretKey: BytesType;
 };
-export { BN, leftPad, rightPad };
 /**
  * Returns a BN object, converts a number value to a BN
  * @param {string|number|BN} `arg` input a string number, hex string number, number, BigNumber or BN object
  * @return {BN} `output` BN object of the number
  * @throws if the argument is not an array, object that isn't a bignumber, not a string number or number
  */
-export declare const numberToBN: (arg: string | number | BN) => BN;
+declare const numberToBN: (arg: string | number | BN) => BN;
 /**
  * Returns a `boolean` on whether or not the `string` starts with '0x'
  *
@@ -26,14 +27,14 @@ export declare const numberToBN: (arg: string | number | BN) => BN;
  * @return {Boolean} a boolean if it is or is not hex prefixed
  * @throws if the str input is not a string
  */
-export declare const isHexPrefixed: (str: string) => boolean;
+declare const isHexPrefixed: (str: string) => boolean;
 /**
  * Removes '0x' from a given `String` if present
  *
  * @public
  * @static
  */
-export declare const stripHexPrefix: (str: string | any) => any;
+declare const stripHexPrefix: (str: string | any) => any;
 /**
  * Returns true if object is BN, otherwise false
  *
@@ -43,7 +44,7 @@ export declare const stripHexPrefix: (str: string | any) => any;
  * @param {Object} object
  * @returns {Boolean}
  */
-export declare const isBN: (object: $TSFixMe) => boolean;
+declare const isBN: (object: $TSFixMe) => boolean;
 /**
  * Returns true if object is BigNumber, otherwise false
  *
@@ -53,7 +54,7 @@ export declare const isBN: (object: $TSFixMe) => boolean;
  * @param {Object} object
  * @returns {Boolean}
  */
-export declare const isBigNumber: (object: $TSFixMe) => boolean;
+declare const isBigNumber: (object: $TSFixMe) => boolean;
 /**
  * Check if string is HEX, requires a 0x in front
  *
@@ -63,7 +64,7 @@ export declare const isBigNumber: (object: $TSFixMe) => boolean;
  * @param {String} hex to be checked
  * @returns {Boolean}
  */
-export declare const isHexStrict: (hex: string) => boolean;
+declare const isHexStrict: (hex: string) => boolean;
 /**
  * Check if string is HEX
  *
@@ -73,7 +74,7 @@ export declare const isHexStrict: (hex: string) => boolean;
  * @param {String} hex to be checked
  * @returns {Boolean}
  */
-export declare const isHex: (hex: string) => boolean;
+declare const isHex: (hex: string) => boolean;
 /**
  * Takes an input and transforms it into an BN
  *
@@ -83,7 +84,7 @@ export declare const isHex: (hex: string) => boolean;
  * @param {Number|String|BN} num, string, HEX string or BN
  * @returns {BN} BN
  */
-export declare const toBN: (num: number | string | BN, base?: number | "hex") => BN;
+declare const toBN: (num: number | string | BN, base?: number | "hex") => BN;
 /**
  * Should be called to get hex representation (prefixed by 0x) of utf8 string
  *
@@ -93,7 +94,7 @@ export declare const toBN: (num: number | string | BN, base?: number | "hex") =>
  * @param {String} str
  * @returns {String} hex representation of input string
  */
-export declare const utf8ToHex: (str: string) => string;
+declare const utf8ToHex: (str: string) => string;
 /**
  * Should be called to get utf8 from it's hex representation
  *
@@ -103,7 +104,7 @@ export declare const utf8ToHex: (str: string) => string;
  * @param {String} hex
  * @returns {String} ascii string representation of hex value
  */
-export declare const hexToUtf8: (hex: string) => string;
+declare const hexToUtf8: (hex: string) => string;
 /**
  * Converts value to number representation
  *
@@ -113,7 +114,7 @@ export declare const hexToUtf8: (hex: string) => string;
  * @param {String|Number|BN} value
  * @returns {Number}
  */
-export declare const hexToNumber: (value: string | number | BN) => number;
+declare const hexToNumber: (value: string | number | BN) => number;
 /**
  * Converts value to hex representation
  *
@@ -123,7 +124,7 @@ export declare const hexToNumber: (value: string | number | BN) => number;
  * @param {String|Number|BN} value
  * @returns {String}
  */
-export declare const numberToHex: (value: $TSFixMe) => string;
+declare const numberToHex: (value: $TSFixMe) => string;
 /**
  * Convert a byte array to a hex string
  * Note: Implementation from crypto-js
@@ -134,7 +135,7 @@ export declare const numberToHex: (value: $TSFixMe) => string;
  * @param {Array} bytes
  * @returns {String} the hex string
  */
-export declare const bytesToHex: (bytes: $TSFixMe) => string;
+declare const bytesToHex: (bytes: $TSFixMe) => string;
 /**
  * Convert a hex string to a byte array
  * Note: Implementation from crypto-js
@@ -145,7 +146,7 @@ export declare const bytesToHex: (bytes: $TSFixMe) => string;
  * @param {String} hex
  * @returns {Array} the byte array
  */
-export declare const hexToBytes: (hex: $TSFixMe) => Array<any>;
+declare const hexToBytes: (hex: $TSFixMe) => Array<any>;
 /**
  * Auto converts any given value into it's hex representation.
  * And even stringify objects before.
@@ -157,63 +158,65 @@ export declare const hexToBytes: (hex: $TSFixMe) => Array<any>;
  * @param {Boolean} returnType
  * @returns {String}
  */
-export declare const toHex: (value: string | number | boolean | BN | Uint8Array | Buffer | (number | {
-    test: string;
+declare const toHex: (value: string | number | boolean | BN | Uint8Array | Buffer | (number | {
+  test: string;
 })[] | {
-    test: string;
+  test: string;
 }, returnType?: boolean) => string;
-export declare const numberToString: (arg: $TSFixMe) => any;
+declare const numberToString: (arg: $TSFixMe) => any;
 /**
  * Format a big number to human readable number, such as 1_0000_0000_0000_000 => 1 Token
  */
-export declare const fromUnitToToken: (input: string | number | BN, decimal?: number, optionsInput?: $TSFixMe) => string;
+declare const fromUnitToToken: (input: string | number | BN, decimal?: number, optionsInput?: $TSFixMe) => string;
 /**
  * Convert human readable token number to big number instance
  */
-export declare const fromTokenToUnit: (input: string | number, decimal?: number) => BN;
+declare const fromTokenToUnit: (input: string | number, decimal?: number) => BN;
 /**
  * Validates if a value is an Uint8Array.
  */
-export declare function isUint8Array(value: $TSFixMe): boolean;
+declare function isUint8Array(value: $TSFixMe): boolean;
 /**
  * Generate a random UUID
  */
-export declare function UUID(): string;
+declare function UUID(): string;
 /**
  * Check if a string is valid UUID
  */
-export declare function isUUID(str: string): boolean;
+declare function isUUID(str: string): boolean;
 /**
  * Convert input to Uint8Array on best effort, base64 node supported
  */
-export declare function toUint8Array(v: any): Uint8Array;
+declare function toUint8Array(v: any): Uint8Array;
 /**
  * Convert input to Buffer on best effort, base64 not supported
  */
-export declare function toBuffer(v: any): Buffer;
+declare function toBuffer(v: any): Buffer;
 /**
  * Convert input to base58btc format on best effort
  */
-export declare function toBase58(v: any): string;
+declare function toBase58(v: any): string;
 /**
  * Decode base58 string
  */
-export declare function fromBase58(v: string): Buffer;
+declare function fromBase58(v: string): Buffer;
 /**
  * Convert input to base64 format
  */
-export declare function toBase64(v: any, escape?: boolean): string;
+declare function toBase64(v: any, escape?: boolean): string;
 /**
  * Decode base64(base64_url) string to buffer
  */
-export declare function fromBase64(v: string): Buffer;
+declare function fromBase64(v: string): Buffer;
 /**
  * Convert did to address: remove `did:abt:` prefix
  */
-export declare function toAddress(did: string): string;
+declare function toAddress(did: string): string;
 /**
  * Convert address to did: prepend `did:abt:` prefix
  */
-export declare function toDid(address: string): string;
-export declare function isSameDid(a: string, b: string): boolean;
-export declare function formatTxType(type: string): any;
+declare function toDid(address: string): string;
+declare function isSameDid(a: string, b: string): boolean;
+declare function formatTxType(type: string): Capitalize<string>;
+//#endregion
+export { BN, BytesType, EncodingType, KeyPairType, UUID, bytesToHex, formatTxType, fromBase58, fromBase64, fromTokenToUnit, fromUnitToToken, hexToBytes, hexToNumber, hexToUtf8, isBN, isBase58btc, isBigNumber, isHex, isHexPrefixed, isHexStrict, isSameDid, isUUID, isUint8Array, leftPad, numberToBN, numberToHex, numberToString, rightPad, stripHexPrefix, toAddress, toBN, toBase58, toBase64, toBuffer, toDid, toHex, toUint8Array, utf8ToHex };