https://github.com/kchapelier/ya-base62
Yet Another Base62, first and foremost designed to encode to and decode from structured strings.
https://github.com/kchapelier/ya-base62
Last synced: 6 months ago
JSON representation
Yet Another Base62, first and foremost designed to encode to and decode from structured strings.
- Host: GitHub
- URL: https://github.com/kchapelier/ya-base62
- Owner: kchapelier
- License: mit
- Created: 2017-05-14T18:38:45.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-02T16:43:12.000Z (over 8 years ago)
- Last Synced: 2025-03-24T15:41:33.693Z (6 months ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yet Another Base62
[](https://travis-ci.org/kchapelier/ya-base62) [](http://badge.fury.io/js/ya-base62)
## Installing and testing
With [npm](http://npmjs.org) do:
```
npm install ya-base62
```
To run the test suite, run the following command from the ```ya-base62``` directory:
```
npm test
```
## Features
* First and foremost designed to encode/decode multiple values to/from a structured string.
* Comparatively fast decoding.
* The library doesn't support big numbers (integers encoded on more than 51 bits, > Number.MAX_SAFE_INTEGER).
* The library doesn't support custom charsets (it is hardcoded to
`0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ` which is the default charset of most existing
implementations).
## Usage
### Encoding a structured string
```js
var yabe62 = require('ya-base62');
var width = 600,
height = 480,
value = 12093;
var structuredString = (
yabe62.mbValueToBase62(width, 2) +
yabe62.mbValueToBase62(height, 2) +
yabe62.mbValueToBase62(value, 8)
); // '9G7K00000393'
```
### Decoding a structured string
```js
var yabe62 = require('ya-base62');
var structuredString = '9G7K00000393';
console.log(
yabe62.mbValueFromBase62(structuredString, 0, 2),
yabe62.mbValueFromBase62(structuredString, 2, 2),
yabe62.mbValueFromBase62(structuredString, 4, 8)
); // 600 480 12093
```
### Decoding and encoding unstructured string
```js
var yabe62 = require('ya-base62');
console.log(yabe62.encode(1200050000)); // '1jdhPa'
console.log(yabe62.decode('1jdhPa')); // 1200050000
```
## Public API
The module is exposing 6 pure functions.
**sbValueToBase62(value)**
Convert an integer value to a single byte base 62 value.
* *value :* An integer in the [0-61] range.
**sbValueFromBase62(string, position)**
Convert a single byte base 62 value to an integer.
* *string :* String containing the single byte base 62 value.
* *position :* Position of the character to decode.
**mbValueToBase62(value, length)**
Convert an integer value to a multiple byte base 62 value.
* *value :* An integer in the [0-(62 ** length - 1)] range.
* *length :* The number of bytes.
**mbValueFromBase62(string, position, length)**
Convert a multiple byte base 62 value to an integer.
* *string :* String containing the multiple byte base 62 value.
* *position :* Start position of the characters to decode.
* *length :* Number of bytes to decode.
**encode(value)**
Convert an integer to a base 62 value.
* *value :* Positive integer to encode.
**decode(string)**
Convert the entirety of a given base 62 string to an integer.
* *string :* String containing the base 62 value to decode.
## Benchmark
It should be noted that this benchmark is slightly unfair. The slowness of the other module when decoding can be
explained by the fact that they allow the use of custom charset.
| Operation | Module | Results | Time elapsed |
| ---------- | ------ | ------- | ------------ |
| decoding (1000000x) | ya-base62@1.0.0 | correct | 92.60 ms |
| decoding (1000000x) | base62@1.2.0 | correct | 69.02 ms |
| decoding (1000000x) | base62.js@0.5.0 | correct | 545.01 ms |
| encoding (1000000x) | ya-base62@1.0.0 | correct | 74.94 ms |
| encoding (1000000x) | base62@1.2.0 | correct | 66.99 ms |
| encoding (1000000x) | base62js@0.5.0 | correct | 80.39 ms |
| mbValueToBase62 on 10 characters (1000000x) | ya-base62@1.0.0 | correct | 190.31 ms |
[Benchmark code](https://github.com/kchapelier/ya-base62/blob/master/benchmark/benchmarks.js)
## Changelog
### 1.0.0 (2017.05.14) :
* First implementation
## License
MIT