mirror of
https://github.com/jimeh/node-base58.git
synced 2026-02-19 07:36:40 +00:00
Jim Myhrberg
8eaae0b86a
- `encode()`: Renamed to `int_to_base58()`. - `decode()`: Renamed to `base58_to_int()`. - Maintain aliases of old function names for backwards compatibility.
38 lines
946 B
Markdown
38 lines
946 B
Markdown
# node-base58 [](http://travis-ci.org/jimeh/node-base58)
|
|
|
|
A Base58 encoding and decoding library for [Node.js].
|
|
|
|
[node.js]: http://nodejs.org/
|
|
|
|
## What?
|
|
|
|
Base58 allows you to represent a numeric value with fewer characters, useful
|
|
for short URLs among other things. Flickr is one the biggest sites that makes
|
|
use of it for short photo URLs.
|
|
|
|
For example `6857269519` becomes `brXijP` when Base58 encoded, and hence the
|
|
Flickr short URL is: `http://flic.kr/p/brXijP`
|
|
|
|
## Installation
|
|
|
|
npm install base58
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
const Base58 = require('base58');
|
|
Base58.int_to_base58(6857269519); // 'brXijP'
|
|
Base58.base58_to_int('brXijP'); // 6857269519
|
|
```
|
|
|
|
## Credit
|
|
|
|
This package is more or less a port of the [Base58][gem] Ruby Gem by the same
|
|
name.
|
|
|
|
[gem]: https://github.com/dougal/base58
|
|
|
|
## License
|
|
|
|
Released under the MIT license. Copyright (c) 2012 Jim Myhrberg.
|