@sindresorhus/base62
v0.1.0
Published
Encode & decode strings, bytes, and integers to Base62
Downloads
476
Maintainers
Readme
base62
Encode & decode strings, bytes, and integers to Base62
Base62 is ideal for URL shortening, creating readable codes, and compact data representation, because it compresses large values into shorter, alphanumeric strings, maximizing space efficiency and readability.
Install
npm install @sindresorhus/base62
Usage
import base62 from '@sindresorhus/base62';
const encodedString = base62.encodeString('Hello world!');
console.log(encodedString);
//=> '8nlogx6nlNdJhVT24v'
console.log(base62.decodeString(encodedString));
//=> 'Hello world!'
console.log(base62.encodeString('🦄'));
//=> '95s3vg'
console.log(base62.encodeInteger(1337));
//=> 'LZ'
[!NOTE] The output may differ from other Base62 encoders due to variations in alphabet order and byte encoding.
API
It uses the most common alphabet for Base62: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
encodeString(string: string): string
Encodes a string to a Base62 string.
[!CAUTION] The result format is not yet guaranteed to be stable across package versions. Avoid using it for persistent storage.
decodeString(encodedString: string): string
Decodes a Base62 encoded string created with encodeString()
back to the original string.
encodeBytes(bytes: Uint8Array): string
Encodes bytes to a Base62 string.
[!CAUTION] The result format is not yet guaranteed to be stable across package versions. Avoid using it for persistent storage.
decodeBytes(encodedString: string): Uint8Array
Decodes a Base62 string created with encodeBytes()
back to bytes.
encodeInteger(integer: number): string
Encodes a non-negative integer to a Base62 string.
decodeInteger(encodedString: string): number
Decodes a Base62 string to an integer.
encodeBigInt(integer: bigint): string
Encodes a non-negative bigint to a Base62 string.
decodeBigInt(encodedString: string): bigint
Decodes a Base62 string to a bigint.