Add Blake2s & XXHash utility functions (#66)

* Initial split of util & util-crypto

* Add initial XXHash version

* Blake2s wit tests & documentation

* Add sha512 (from NaCl)

* Add randomBytes (from NaCl)

* Flow fixes

* Update documentation

* Update latest @polkadot/dev
This commit is contained in:
Jaco Greeff
2018-01-25 14:13:43 +01:00
committed by GitHub
parent ade4c828af
commit b5c5734c7c
183 changed files with 1802 additions and 109 deletions
+13
View File
@@ -0,0 +1,13 @@
// Copyright 2017-2018 Jaco Greeff
// This software may be modified and distributed under the terms
// of the ISC license. See the LICENSE file for details.
// @flow
const stringShorten = require('./shorten');
/**
@summary Utility methods to convert to work with `string` values
*/
module.exports = {
stringShorten
};
+26
View File
@@ -0,0 +1,26 @@
// Copyright 2017-2018 Jaco Greeff
// This software may be modified and distributed under the terms
// of the ISC license. See the LICENSE file for details.
// @flow
/**
@name stringShorten
@signature stringShorten (value: mixed, prefixLength: number = 8): string
@summary Returns a string with maximum length
@description
Checks the string against the `prefixLength`, if longer than dopuble this, shortens it by placing `..` in the middle of it
@example
import { stringShorten } from '@polkadot/util';
stringShorten('1234567890', 2); // => 12..90
*/
module.exports = function stringShorten (_value: mixed, prefixLength: number = 6): string {
// $FlowFixMe coerced into string (by any means)
const value = `${_value}`;
if (value.length <= 2 + 2 * prefixLength) {
return value;
}
return `${value.substr(0, prefixLength)}..${value.slice(-prefixLength)}`;
};
+31
View File
@@ -0,0 +1,31 @@
// Copyright 2017-2018 Jaco Greeff
// This software may be modified and distributed under the terms
// of the ISC license. See the LICENSE file for details.
const { stringShorten } = require('./index');
describe('stringShorten', () => {
it('returns the value as-is when <= maxLength', () => {
expect(
stringShorten('0123456789', 4)
).toEqual('0123456789');
});
it('returns the shortened value when > maxLength', () => {
expect(
stringShorten('0123456789', 3)
).toEqual('012..789');
});
it('returns undefined as undefined', () => {
expect(
stringShorten()
).toEqual('undefined');
});
it('returns non-string values as strings', () => {
expect(
stringShorten(12345678, 2)
).toEqual('12..78');
});
});