jimeh/node-base58
1
0
Fork 0
mirror of https://github.com/jimeh/node-base58.git synced 2026-02-18 23:26:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Give encode/decode functions more descriptive names

Browse Source 
- `encode()`: Renamed to `int_to_base58()`.
- `decode()`: Renamed to `base58_to_int()`.
- Maintain aliases of old function names for backwards compatibility.
This commit is contained in:
Jim Myhrberg
2018-11-18 22:17:56 +00:00
parent 35dd6f57a1
commit 8eaae0b86a
3 changed files with 25 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -21,8 +21,8 @@ Flickr short URL is: `http://flic.kr/p/brXijP`
```javascript
const Base58 = require('base58');
Base58.encode(6857269519); // 'brXijP'
Base58.decode('brXijP'); // 6857269519
Base58.int_to_base58(6857269519); // 'brXijP'
Base58.base58_to_int('brXijP'); // 6857269519
```
## Credit

4
src/base58.js
View File

@@ -31,7 +31,7 @@ function assertBase58Character(character) {
}
}
exports.encode = function(num) {
exports.int_to_base58 = exports.encode = function(num) {
let str = "";
let modulus;
@@ -48,7 +48,7 @@ exports.encode = function(num) {
return alphabet[num] + str;
};
exports.decode = function(str) {
exports.base58_to_int = exports.decode = function(str) {
assertString(str);
return [...str].reverse().reduce((num, character, index) => {

32
test/base58.test.js
View File

@@ -27,17 +27,27 @@ describe("Base58", function() {
assert.strictEqual(valid, true, "Expected the examples to be valid");
});
describe(".encode", function() {
describe("backwards compatibility", function() {
it(".encode() is an alias to .int_to_base58()", function() {
assert.strictEqual(base58.encode, base58.int_to_base58);
});
it(".decode() is an alias to .base58_to_int()", function() {
assert.strictEqual(base58.decode, base58.base58_to_int);
});
});
describe(".int_to_base58()", function() {
it("encodes number to Base58 string", function() {
exampleRunner(function(str, num) {
assert.strictEqual(base58.encode(num), str);
assert.strictEqual(base58.int_to_base58(num), str);
});
});
describe("when passed a string only containing numbers", function() {
it("encodes string after first converting it to an integer", function() {
exampleRunner(function(str, num) {
assert.strictEqual(base58.encode(num.toString()), str);
assert.strictEqual(base58.int_to_base58(num.toString()), str);
});
});
});
@@ -46,7 +56,7 @@ describe("Base58", function() {
it("throws an error", function() {
assert.throws(
function() {
base58.encode("hi");
base58.int_to_base58("hi");
},
function(err) {
return (
@@ -61,7 +71,7 @@ describe("Base58", function() {
it("throws an error", function() {
assert.throws(
function() {
base58.encode(3.14);
base58.int_to_base58(3.14);
},
function(err) {
return (
@@ -76,7 +86,7 @@ describe("Base58", function() {
it("throws an error", function() {
assert.throws(
function() {
base58.encode(-300);
base58.int_to_base58(-300);
},
function(err) {
return (
@@ -91,7 +101,7 @@ describe("Base58", function() {
it("throws an error", function() {
assert.throws(
function() {
base58.encode(1e100);
base58.int_to_base58(1e100);
},
function(err) {
return (
@@ -103,10 +113,10 @@ describe("Base58", function() {
});
});
describe(".decode", function() {
describe(".base58_to_int()", function() {
it("decodes base58 string to number", function() {
exampleRunner(function(str, num) {
assert.strictEqual(base58.decode(str), num);
assert.strictEqual(base58.base58_to_int(str), num);
});
});
@@ -114,7 +124,7 @@ describe("Base58", function() {
it("throws an error", function() {
assert.throws(
function() {
base58.decode(123);
base58.base58_to_int(123);
},
function(err) {
return err.message === "Value passed is not a string.";
@@ -127,7 +137,7 @@ describe("Base58", function() {
it("throws an error", function() {
assert.throws(
function() {
base58.decode(">_<");
base58.base58_to_int(">_<");
},
function(err) {
return err.message === "Value passed is not a valid Base58 string.";