From 1e6eb2c2834f4645dc4868bd3b2bcd6d4e79f876 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Thu, 14 Feb 2019 10:48:08 +0100 Subject: [PATCH] Converts tests to TypeScript (#300) --- packages/db/package.json | 1 + .../{Compact.spec.js => Compact.spec.ts} | 9 +++------ .../FileFlatDb/{index.spec.js => index.spec.ts} | 9 ++++----- .../engines/{LruDb.spec.js => LruDb.spec.ts} | 0 ...nsactionDb.spec.js => TransactionDb.spec.ts} | 2 +- packages/keyring/src/index.ts | 10 ---------- packages/keyring/src/testing.ts | 1 - packages/trie-codec/src/util/fromNibbles.ts | 1 - packages/trie-codec/src/util/toNibbles.ts | 1 - packages/trie-db/src/util/is.ts | 5 ----- packages/trie-hash/src/trieRoot.ts | 1 - packages/trie-hash/src/trieRootOrdered.ts | 1 - .../src/blake2/{asHex.spec.js => asHex.spec.ts} | 0 packages/util-crypto/src/blake2/asHex.ts | 3 +-- .../src/blake2/{asU8a.spec.js => asU8a.spec.ts} | 0 packages/util-crypto/src/blake2/asU8a.ts | 3 +-- .../blake2b/{asHex.spec.js => asHex.spec.ts} | 0 .../util-crypto/src/blake2/blake2b/asHex.ts | 3 +-- .../blake2b/{asU8a.spec.js => asU8a.spec.ts} | 0 .../util-crypto/src/blake2/blake2b/asU8a.ts | 3 +-- .../src/keccak/{asHex.spec.js => asHex.spec.ts} | 0 packages/util-crypto/src/keccak/asHex.ts | 1 - .../src/keccak/{asU8a.spec.js => asU8a.spec.ts} | 0 packages/util-crypto/src/keccak/asU8a.ts | 1 - .../{generate.spec.js => generate.spec.ts} | 0 packages/util-crypto/src/mnemonic/generate.ts | 1 - .../{toSecret.spec.js => toSecret.spec.ts} | 0 packages/util-crypto/src/mnemonic/toSeed.ts | 1 - .../{validate.spec.js => validate.spec.ts} | 0 packages/util-crypto/src/mnemonic/validate.ts | 1 - packages/util-crypto/src/nacl/decrypt.ts | 1 - packages/util-crypto/src/nacl/encrypt.ts | 1 - .../util-crypto/src/nacl/keypair/fromRandom.ts | 1 - .../util-crypto/src/nacl/keypair/fromSecret.ts | 1 - .../util-crypto/src/nacl/keypair/fromSeed.ts | 1 - .../util-crypto/src/nacl/keypair/fromString.ts | 1 - packages/util-crypto/src/nacl/sign.ts | 1 - packages/util-crypto/src/nacl/verify.ts | 1 - .../src/random/{asHex.spec.js => asHex.spec.ts} | 0 packages/util-crypto/src/random/asHex.ts | 1 - .../{asNumber.spec.js => asNumber.spec.ts} | 0 packages/util-crypto/src/random/asNumber.ts | 1 - .../src/random/{asU8a.spec.js => asU8a.spec.ts} | 0 packages/util-crypto/src/random/asU8a.ts | 1 - .../src/sha512/{asU8a.spec.js => asU8a.spec.ts} | 0 packages/util-crypto/src/sha512/asU8a.ts | 1 - .../src/xxhash/{asHex.spec.js => asHex.spec.ts} | 0 packages/util-crypto/src/xxhash/asHex.ts | 1 - .../src/xxhash/{asU8a.spec.js => asU8a.spec.ts} | 0 packages/util-crypto/src/xxhash/asU8a.ts | 1 - .../xxhash64/{asBn.spec.js => asBn.spec.ts} | 0 .../util-crypto/src/xxhash/xxhash64/asBn.ts | 1 - .../xxhash64/{asHex.spec.js => asHex.spec.ts} | 0 .../util-crypto/src/xxhash/xxhash64/asHex.ts | 1 - .../xxhash64/{asRaw.spec.js => asRaw.spec.ts} | 0 .../util-crypto/src/xxhash/xxhash64/asRaw.ts | 1 - .../{asValue.spec.js => asValue.spec.ts} | 0 .../util-crypto/src/xxhash/xxhash64/asValue.ts | 1 - .../src/{decode.spec.js => decode.spec.ts} | 2 +- packages/util-rlp/src/decoder/index.ts | 1 - ...afeParseInt.spec.js => safeParseInt.spec.ts} | 0 .../src/{encode.spec.js => encode.spec.ts} | 0 packages/util-rlp/src/encoder/index.ts | 1 - .../encoder/{length.spec.js => length.spec.ts} | 0 .../encoder/{toU8a.spec.js => toU8a.spec.ts} | 0 packages/util-rlp/src/encoder/toU8a.ts | 2 +- .../array/{filter.spec.js => filter.spec.ts} | 0 packages/util/src/array/filter.ts | 1 - .../util/src/{assert.spec.js => assert.spec.ts} | 0 packages/util/src/assert.ts | 5 +++-- .../src/bn/{fromHex.spec.js => fromHex.spec.ts} | 0 packages/util/src/bn/fromHex.ts | 1 - .../util/src/bn/{toBn.spec.js => toBn.spec.ts} | 0 packages/util/src/bn/toBn.ts | 1 - packages/util/src/bn/toHex.ts | 1 - packages/util/src/bn/toU8a.ts | 1 - .../src/buffer/{toU8a.spec.js => toU8a.spec.ts} | 0 packages/util/src/buffer/toU8a.ts | 3 +-- .../src/ext/{error.spec.js => error.spec.ts} | 4 ++-- packages/util/src/ext/error.ts | 1 - .../{addPrefix.spec.js => addPrefix.spec.ts} | 0 packages/util/src/hex/addPrefix.ts | 3 +-- .../{fixLength.spec.js => fixLength.spec.ts} | 0 packages/util/src/hex/fixLength.ts | 1 - .../{hasPrefix.spec.js => hasPrefix.spec.ts} | 2 +- packages/util/src/hex/hasPrefix.ts | 3 +-- ...{stripPrefix.spec.js => stripPrefix.spec.ts} | 0 packages/util/src/hex/stripPrefix.ts | 3 +-- packages/util/src/hex/toBn.ts | 1 - .../hex/{toNumber.spec.js => toNumber.spec.ts} | 0 packages/util/src/hex/toNumber.ts | 3 +-- .../src/hex/{toU8a.spec.js => toU8a.spec.ts} | 0 packages/util/src/hex/toU8a.ts | 1 - .../util/src/{index.spec.js => index.spec.ts} | 0 packages/util/src/is/{bn.spec.js => bn.spec.ts} | 0 packages/util/src/is/bn.ts | 1 - .../src/is/{boolean.spec.js => boolean.spec.ts} | 0 packages/util/src/is/boolean.ts | 1 - .../src/is/{buffer.spec.js => buffer.spec.ts} | 0 packages/util/src/is/buffer.ts | 1 - .../src/is/{error.spec.js => error.spec.ts} | 0 packages/util/src/is/error.ts | 1 - .../is/{function.spec.js => function.spec.ts} | 0 packages/util/src/is/function.ts | 1 - .../util/src/is/{hex.spec.js => hex.spec.ts} | 1 - packages/util/src/is/hex.ts | 1 - .../{instanceOf.spec.js => instanceOf.spec.ts} | 0 packages/util/src/is/instanceOf.ts | 1 - packages/util/src/is/{ip.spec.js => ip.spec.ts} | 0 packages/util/src/is/ip.ts | 1 - .../util/src/is/{null.spec.js => null.spec.ts} | 0 packages/util/src/is/null.ts | 3 +-- .../src/is/{number.spec.js => number.spec.ts} | 0 packages/util/src/is/number.ts | 1 - .../src/is/{object.spec.js => object.spec.ts} | 0 packages/util/src/is/object.ts | 1 - .../{observable.spec.js => observable.spec.ts} | 0 packages/util/src/is/observable.ts | 1 - .../src/is/{string.spec.js => string.spec.ts} | 0 packages/util/src/is/string.ts | 1 - .../util/src/is/{u8a.spec.js => u8a.spec.ts} | 0 packages/util/src/is/u8a.ts | 3 +-- .../is/{undefined.spec.js => undefined.spec.ts} | 0 packages/util/src/is/undefined.ts | 3 +-- .../util/src/{logger.spec.js => logger.spec.ts} | 17 ++++++++--------- packages/util/src/logger.ts | 1 - .../src/number/{toHex.spec.js => toHex.spec.ts} | 0 packages/util/src/number/toHex.ts | 3 +-- .../src/number/{toU8a.spec.js => toU8a.spec.ts} | 0 packages/util/src/number/toU8a.ts | 3 +-- ...{textDecoder.spec.js => textDecoder.spec.ts} | 14 +++++++------- ...{textEncoder.spec.js => textEncoder.spec.ts} | 14 +++++++------- .../{promisify.spec.js => promisify.spec.ts} | 11 ++++++----- packages/util/src/promisify.ts | 1 - .../{camelCase.spec.js => camelCase.spec.ts} | 2 +- .../{lowerFirst.spec.js => lowerFirst.spec.ts} | 8 ++++---- packages/util/src/string/lowerFirst.ts | 12 ++++-------- .../string/{shorten.spec.js => shorten.spec.ts} | 0 packages/util/src/string/shorten.ts | 3 +-- .../src/string/{toU8a.spec.js => toU8a.spec.ts} | 0 packages/util/src/string/toU8a.ts | 1 - .../{upperFirst.spec.js => upperFirst.spec.ts} | 8 ++++---- packages/util/src/string/upperFirst.ts | 12 ++++-------- .../src/{syncify.spec.js => syncify.spec.ts} | 0 .../src/u8a/{concat.spec.js => concat.spec.ts} | 0 packages/util/src/u8a/concat.ts | 1 - .../{fixLength.spec.js => fixLength.spec.ts} | 0 packages/util/src/u8a/fixLength.ts | 1 - packages/util/src/u8a/toBn.ts | 1 - .../u8a/{toBuffer.spec.js => toBuffer.spec.ts} | 0 packages/util/src/u8a/toBuffer.ts | 3 +-- .../src/u8a/{toHex.spec.js => toHex.spec.ts} | 4 ++-- packages/util/src/u8a/toHex.ts | 1 - .../u8a/{toString.spec.js => toString.spec.ts} | 0 packages/util/src/u8a/toString.ts | 3 +-- .../src/u8a/{toU8a.spec.js => toU8a.spec.ts} | 0 packages/util/src/u8a/toU8a.ts | 1 - yarn.lock | 8 ++++++++ 158 files changed, 89 insertions(+), 183 deletions(-) rename packages/db/src/FileFlatDb/{Compact.spec.js => Compact.spec.ts} (74%) rename packages/db/src/FileFlatDb/{index.spec.js => index.spec.ts} (97%) rename packages/db/src/engines/{LruDb.spec.js => LruDb.spec.ts} (100%) rename packages/db/src/engines/{TransactionDb.spec.js => TransactionDb.spec.ts} (99%) rename packages/util-crypto/src/blake2/{asHex.spec.js => asHex.spec.ts} (100%) rename packages/util-crypto/src/blake2/{asU8a.spec.js => asU8a.spec.ts} (100%) rename packages/util-crypto/src/blake2/blake2b/{asHex.spec.js => asHex.spec.ts} (100%) rename packages/util-crypto/src/blake2/blake2b/{asU8a.spec.js => asU8a.spec.ts} (100%) rename packages/util-crypto/src/keccak/{asHex.spec.js => asHex.spec.ts} (100%) rename packages/util-crypto/src/keccak/{asU8a.spec.js => asU8a.spec.ts} (100%) rename packages/util-crypto/src/mnemonic/{generate.spec.js => generate.spec.ts} (100%) rename packages/util-crypto/src/mnemonic/{toSecret.spec.js => toSecret.spec.ts} (100%) rename packages/util-crypto/src/mnemonic/{validate.spec.js => validate.spec.ts} (100%) rename packages/util-crypto/src/random/{asHex.spec.js => asHex.spec.ts} (100%) rename packages/util-crypto/src/random/{asNumber.spec.js => asNumber.spec.ts} (100%) rename packages/util-crypto/src/random/{asU8a.spec.js => asU8a.spec.ts} (100%) rename packages/util-crypto/src/sha512/{asU8a.spec.js => asU8a.spec.ts} (100%) rename packages/util-crypto/src/xxhash/{asHex.spec.js => asHex.spec.ts} (100%) rename packages/util-crypto/src/xxhash/{asU8a.spec.js => asU8a.spec.ts} (100%) rename packages/util-crypto/src/xxhash/xxhash64/{asBn.spec.js => asBn.spec.ts} (100%) rename packages/util-crypto/src/xxhash/xxhash64/{asHex.spec.js => asHex.spec.ts} (100%) rename packages/util-crypto/src/xxhash/xxhash64/{asRaw.spec.js => asRaw.spec.ts} (100%) rename packages/util-crypto/src/xxhash/xxhash64/{asValue.spec.js => asValue.spec.ts} (100%) rename packages/util-rlp/src/{decode.spec.js => decode.spec.ts} (96%) rename packages/util-rlp/src/decoder/{safeParseInt.spec.js => safeParseInt.spec.ts} (100%) rename packages/util-rlp/src/{encode.spec.js => encode.spec.ts} (100%) rename packages/util-rlp/src/encoder/{length.spec.js => length.spec.ts} (100%) rename packages/util-rlp/src/encoder/{toU8a.spec.js => toU8a.spec.ts} (100%) rename packages/util/src/array/{filter.spec.js => filter.spec.ts} (100%) rename packages/util/src/{assert.spec.js => assert.spec.ts} (100%) rename packages/util/src/bn/{fromHex.spec.js => fromHex.spec.ts} (100%) rename packages/util/src/bn/{toBn.spec.js => toBn.spec.ts} (100%) rename packages/util/src/buffer/{toU8a.spec.js => toU8a.spec.ts} (100%) rename packages/util/src/ext/{error.spec.js => error.spec.ts} (96%) rename packages/util/src/hex/{addPrefix.spec.js => addPrefix.spec.ts} (100%) rename packages/util/src/hex/{fixLength.spec.js => fixLength.spec.ts} (100%) rename packages/util/src/hex/{hasPrefix.spec.js => hasPrefix.spec.ts} (95%) rename packages/util/src/hex/{stripPrefix.spec.js => stripPrefix.spec.ts} (100%) rename packages/util/src/hex/{toNumber.spec.js => toNumber.spec.ts} (100%) rename packages/util/src/hex/{toU8a.spec.js => toU8a.spec.ts} (100%) rename packages/util/src/{index.spec.js => index.spec.ts} (100%) rename packages/util/src/is/{bn.spec.js => bn.spec.ts} (100%) rename packages/util/src/is/{boolean.spec.js => boolean.spec.ts} (100%) rename packages/util/src/is/{buffer.spec.js => buffer.spec.ts} (100%) rename packages/util/src/is/{error.spec.js => error.spec.ts} (100%) rename packages/util/src/is/{function.spec.js => function.spec.ts} (100%) rename packages/util/src/is/{hex.spec.js => hex.spec.ts} (99%) rename packages/util/src/is/{instanceOf.spec.js => instanceOf.spec.ts} (100%) rename packages/util/src/is/{ip.spec.js => ip.spec.ts} (100%) rename packages/util/src/is/{null.spec.js => null.spec.ts} (100%) rename packages/util/src/is/{number.spec.js => number.spec.ts} (100%) rename packages/util/src/is/{object.spec.js => object.spec.ts} (100%) rename packages/util/src/is/{observable.spec.js => observable.spec.ts} (100%) rename packages/util/src/is/{string.spec.js => string.spec.ts} (100%) rename packages/util/src/is/{u8a.spec.js => u8a.spec.ts} (100%) rename packages/util/src/is/{undefined.spec.js => undefined.spec.ts} (100%) rename packages/util/src/{logger.spec.js => logger.spec.ts} (94%) rename packages/util/src/number/{toHex.spec.js => toHex.spec.ts} (100%) rename packages/util/src/number/{toU8a.spec.js => toU8a.spec.ts} (100%) rename packages/util/src/polyfill/{textDecoder.spec.js => textDecoder.spec.ts} (62%) rename packages/util/src/polyfill/{textEncoder.spec.js => textEncoder.spec.ts} (62%) rename packages/util/src/{promisify.spec.js => promisify.spec.ts} (75%) rename packages/util/src/string/{camelCase.spec.js => camelCase.spec.ts} (91%) rename packages/util/src/string/{lowerFirst.spec.js => lowerFirst.spec.ts} (83%) rename packages/util/src/string/{shorten.spec.js => shorten.spec.ts} (100%) rename packages/util/src/string/{toU8a.spec.js => toU8a.spec.ts} (100%) rename packages/util/src/string/{upperFirst.spec.js => upperFirst.spec.ts} (83%) rename packages/util/src/{syncify.spec.js => syncify.spec.ts} (100%) rename packages/util/src/u8a/{concat.spec.js => concat.spec.ts} (100%) rename packages/util/src/u8a/{fixLength.spec.js => fixLength.spec.ts} (100%) rename packages/util/src/u8a/{toBuffer.spec.js => toBuffer.spec.ts} (100%) rename packages/util/src/u8a/{toHex.spec.js => toHex.spec.ts} (93%) rename packages/util/src/u8a/{toString.spec.js => toString.spec.ts} (100%) rename packages/util/src/u8a/{toU8a.spec.js => toU8a.spec.ts} (100%) diff --git a/packages/db/package.json b/packages/db/package.json index 434391b1b..31940cdcf 100644 --- a/packages/db/package.json +++ b/packages/db/package.json @@ -32,6 +32,7 @@ "@polkadot/trie-hash": "^0.34.3", "@polkadot/util": "^0.34.3", "@types/mkdirp": "^0.5.2", + "@types/rimraf": "^2.0.2", "@types/snappy": "^6.0.0", "lru_map": "^0.3.3", "mkdirp": "^0.5.1", diff --git a/packages/db/src/FileFlatDb/Compact.spec.js b/packages/db/src/FileFlatDb/Compact.spec.ts similarity index 74% rename from packages/db/src/FileFlatDb/Compact.spec.js rename to packages/db/src/FileFlatDb/Compact.spec.ts index 588f00c0f..34a9de18f 100644 --- a/packages/db/src/FileFlatDb/Compact.spec.js +++ b/packages/db/src/FileFlatDb/Compact.spec.ts @@ -2,11 +2,6 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import mkdirp from 'mkdirp'; -import os from 'os'; -import path from 'path'; -import rimraf from 'rimraf'; - import FileFlatDb from './index'; describe.skip('FileFlatDb (compacting)', () => { @@ -14,7 +9,9 @@ describe.skip('FileFlatDb (compacting)', () => { it('compacts without failing', () => { expect( - combined.maintain(() => {}) + combined.maintain(() => { + // noop + }) ).not.toBe(0); }); }); diff --git a/packages/db/src/FileFlatDb/index.spec.js b/packages/db/src/FileFlatDb/index.spec.ts similarity index 97% rename from packages/db/src/FileFlatDb/index.spec.js rename to packages/db/src/FileFlatDb/index.spec.ts index 3a61988d7..633d3484e 100644 --- a/packages/db/src/FileFlatDb/index.spec.js +++ b/packages/db/src/FileFlatDb/index.spec.ts @@ -3,7 +3,6 @@ // of the Apache-2.0 license. See the LICENSE file for details. import mkdirp from 'mkdirp'; -import os from 'os'; import path from 'path'; import rimraf from 'rimraf'; @@ -42,11 +41,11 @@ const VAL_F = new Uint8Array([0x42, 1, 2, 3, 4, 5, 6, 0x69]); // NOTE Skipped, doesn't seem to be too happy on CI (cwd issues?) describe.skip('FileFlatDb (basics)', () => { - const testGet = (key, value) => - expect(store.get(key)).toEqual(value); - const location = path.join(process.cwd(), '--test-FileFlatDb'); - let store; + let store: FileFlatDb; + + const testGet = (key: Uint8Array, value: Uint8Array) => + expect(store.get(key)).toEqual(value); beforeAll(() => { mkdirp.sync(location); diff --git a/packages/db/src/engines/LruDb.spec.js b/packages/db/src/engines/LruDb.spec.ts similarity index 100% rename from packages/db/src/engines/LruDb.spec.js rename to packages/db/src/engines/LruDb.spec.ts diff --git a/packages/db/src/engines/TransactionDb.spec.js b/packages/db/src/engines/TransactionDb.spec.ts similarity index 99% rename from packages/db/src/engines/TransactionDb.spec.js rename to packages/db/src/engines/TransactionDb.spec.ts index 8cf517bde..5f0ececda 100644 --- a/packages/db/src/engines/TransactionDb.spec.js +++ b/packages/db/src/engines/TransactionDb.spec.ts @@ -71,7 +71,7 @@ describe('TransactionDb', () => { db.put(key, value); throw new Error('test'); - }) + }); } ).toThrow(/test/); expect(memory.get(key)).toEqual(null); diff --git a/packages/keyring/src/index.ts b/packages/keyring/src/index.ts index cbea10208..31e8d0067 100644 --- a/packages/keyring/src/index.ts +++ b/packages/keyring/src/index.ts @@ -53,7 +53,6 @@ export default class Keyring implements KeyringInstance { /** * @name addPair - * @signature addPair (pair: KeyringPair): KeyringPair * @summary Stores an account, given a keyring pair, as a Key/Value (public key, pair) in Keyring Pair Dictionary */ addPair (pair: KeyringPair): KeyringPair { @@ -62,7 +61,6 @@ export default class Keyring implements KeyringInstance { /** * @name addFromAddress - * @signature addFromAddress (address: string | Uint8Array, meta?: KeyringPair$Meta, defaultEncoded?: Uint8Array): KeyringPair * @summary Stores an account, given an account address, as a Key/Value (public key, pair) in Keyring Pair Dictionary * @description Allows user to explicitely provide separate inputs including account address or public key, and optionally * the associated account metadata, and the default encoded value as arguments (that may be obtained from the json file @@ -75,7 +73,6 @@ export default class Keyring implements KeyringInstance { /** * @name addFromJson - * @signature addFromJson ({ address, encoded, meta }: KeyringPair$Json): KeyringPair * @summary Stores an account, given JSON data, as a Key/Value (public key, pair) in Keyring Pair Dictionary * @description Allows user to provide a json object argument that contains account information (that may be obtained from the json file * of an account backup), and then generates a keyring pair from it that it passes to @@ -87,7 +84,6 @@ export default class Keyring implements KeyringInstance { /** * @name addFromMnemonic - * @signature addFromMnemonic (mnemonic: string, meta?: KeyringPair$Meta): KeyringPair * @summary Stores an account, given a mnemonic, as a Key/Value (public key, pair) in Keyring Pair Dictionary * @description Allows user to provide a mnemonic (seed phrase that is provided when account is originally created) * argument and a metadata argument that contains account information (that may be obtained from the json file @@ -100,7 +96,6 @@ export default class Keyring implements KeyringInstance { /** * @name addFromSeed - * @signature addFromSeed (seed: Uint8Array, meta?: KeyringPair$Meta): KeyringPair * @summary Stores an account, given seed data, as a Key/Value (public key, pair) in Keyring Pair Dictionary * @description Stores in a keyring pair dictionary the public key of the pair as a key and the pair as the associated value. * Allows user to provide the account seed as an argument, and then generates a keyring pair from it that it passes to @@ -116,7 +111,6 @@ export default class Keyring implements KeyringInstance { /** * @name getPair - * @signature getPair (address: string | Uint8Array): KeyringPair * @summary Retrieves an account keyring pair from the Keyring Pair Dictionary, given an account address * @description Returns a keyring pair value from the keyring pair dictionary by performing * a key lookup using the provided account address or public key (after decoding it). @@ -127,7 +121,6 @@ export default class Keyring implements KeyringInstance { /** * @name getPairs - * @signature getPairs (): Array * @summary Retrieves all account keyring pairs from the Keyring Pair Dictionary * @description Returns an array list of all the keyring pair values that are stored in the keyring pair dictionary. */ @@ -137,7 +130,6 @@ export default class Keyring implements KeyringInstance { /** * @name getPublicKeys - * @signature getPublicKeys (): Array * @summary Retrieves Public Keys of all Keyring Pairs stored in the Keyring Pair Dictionary * @description Returns an array list of all the public keys associated with each of the keyring pair values that are stored in the keyring pair dictionary. */ @@ -151,7 +143,6 @@ export default class Keyring implements KeyringInstance { /** * @name removePair - * @signature removePair (address: string | Uint8Array): void * @description Deletes the provided input address or public key from the stored Keyring Pair Dictionary. */ removePair (address: string | Uint8Array): void { @@ -160,7 +151,6 @@ export default class Keyring implements KeyringInstance { /** * @name toJson - * @signature toJson (address: string | Uint8Array, passphrase?: string): KeyringPair$Json * @summary Returns a JSON object associated with the input argument that contains metadata assocated with an account * @description Returns a JSON object containing the metadata associated with an account * when valid address or public key and when the account passphrase is provided if the account secret diff --git a/packages/keyring/src/testing.ts b/packages/keyring/src/testing.ts index 2f2a3faeb..8f8fd857b 100644 --- a/packages/keyring/src/testing.ts +++ b/packages/keyring/src/testing.ts @@ -34,7 +34,6 @@ const SEEDS: { [index: string ]: Uint8Array } = { /** * @name testKeyring - * @signature testKeyring (): KeyringInstance * @summary Create an instance of Keyring pre-populated with locked test accounts * @description The test accounts (i.e. alice, bob, dave, eve, ferdie) * are available on the dev chain and each test account is initialised with DOT funds. diff --git a/packages/trie-codec/src/util/fromNibbles.ts b/packages/trie-codec/src/util/fromNibbles.ts index faffe7f19..70f402a0f 100644 --- a/packages/trie-codec/src/util/fromNibbles.ts +++ b/packages/trie-codec/src/util/fromNibbles.ts @@ -4,7 +4,6 @@ /** * @name fromNibbles - * @signature fromNibbles (nibbles: Uint8Array): Uint8Array * @summary Converts the input to Nibbles. * @description * From an `Uint8Array` input, calculate and return a list of nibbles that makes up the input. diff --git a/packages/trie-codec/src/util/toNibbles.ts b/packages/trie-codec/src/util/toNibbles.ts index 8564c8a4c..eda19b5f7 100644 --- a/packages/trie-codec/src/util/toNibbles.ts +++ b/packages/trie-codec/src/util/toNibbles.ts @@ -4,7 +4,6 @@ /** * @name toNibbles - * @signature toNibbles (input: Uint8Array): Uint8Array * @summary Converts the input to Nibbles. * @description * From an `Uint8Array` input, calculate and return a list of nibbles that makes up the input. diff --git a/packages/trie-db/src/util/is.ts b/packages/trie-db/src/util/is.ts index d76f9b2fb..2fcfc5f0a 100644 --- a/packages/trie-db/src/util/is.ts +++ b/packages/trie-db/src/util/is.ts @@ -10,7 +10,6 @@ import { getNodeType } from './node'; /** * @name isEmptyNode - * @signature isEmptyNode (node: Node): node is NodeEmpty * @summary Returns true if node is NULL * @description Refer to [Merkle Patricia Trie specification](https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization) */ @@ -20,7 +19,6 @@ export function isEmptyNode (node: Node): node is NodeEmpty { /** * @name isKvNode - * @signature isKvNode (node: Node): node is NodeKv * @summary Returns true if node is not empty and contains a single key/value pair * @description Refer to [Merkle Patricia Trie specification](https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization) */ @@ -30,7 +28,6 @@ export function isKvNode (node: Node): node is NodeKv { /** * @name isExtensionNode - * @signature isExtensionNode (node: Node): node is NodeKv * @summary Returns true if node is an Extension 2-item node * @description Refer to [Merkle Patricia Trie specification](https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization) */ @@ -40,7 +37,6 @@ export function isExtensionNode (node: Node): node is NodeKv { /** * @name isLeafNode - * @signature isLeafNode (node: Node): node is NodeKv * @summary Returns true if node is an Leaf 2-item node * @description Refer to [Merkle Patricia Trie specification](https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization) */ @@ -50,7 +46,6 @@ export function isLeafNode (node: Node): node is NodeKv { /** * @name isBranchNode - * @signature isBranchNode (node: Node): node is NodeKv * @summary Returns true if node is an Branch 17-item node * @description Refer to [Merkle Patricia Trie specification](https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization) */ diff --git a/packages/trie-hash/src/trieRoot.ts b/packages/trie-hash/src/trieRoot.ts index d6f755892..926194b79 100644 --- a/packages/trie-hash/src/trieRoot.ts +++ b/packages/trie-hash/src/trieRoot.ts @@ -10,7 +10,6 @@ import unhashedTrie from './unhashedTrie'; /** * @name trieRoot - * @signature trieRoot (pairs: Trie$Pairs): Uint8Array * @summary Creates a trie hash from the supplied pairs. * @description * From an `Array<{k: Uint8Array, v: Uint8Array}>` input, calculate the triehash and return the result as a `Uint8Array`. diff --git a/packages/trie-hash/src/trieRootOrdered.ts b/packages/trie-hash/src/trieRootOrdered.ts index 780006b53..c8be27ef8 100644 --- a/packages/trie-hash/src/trieRootOrdered.ts +++ b/packages/trie-hash/src/trieRootOrdered.ts @@ -11,7 +11,6 @@ import trieRoot from './trieRoot'; /** * @name trieRootOrdered - * @signature trieRootOrdered (values: Array): Uint8Array * @summary Creates a trie hash from the supplied values. * @description * From an `Array` input, calculate the ordered triehash and return the result as a `Uint8Array`. diff --git a/packages/util-crypto/src/blake2/asHex.spec.js b/packages/util-crypto/src/blake2/asHex.spec.ts similarity index 100% rename from packages/util-crypto/src/blake2/asHex.spec.js rename to packages/util-crypto/src/blake2/asHex.spec.ts diff --git a/packages/util-crypto/src/blake2/asHex.ts b/packages/util-crypto/src/blake2/asHex.ts index 0b2d40489..964dc6469 100644 --- a/packages/util-crypto/src/blake2/asHex.ts +++ b/packages/util-crypto/src/blake2/asHex.ts @@ -6,7 +6,6 @@ import blake2bAsHex from './blake2b/asHex'; /** * @name blake2AsHex - * @signature blake2AsHex (data: Uint8Array, bitLength: number = 256): string * @summary Creates a blake2b hex from the input. * @description * From a `Uint8Array` input, create the blake2b and return the result as a hex string with the specified `bitLength`. @@ -19,6 +18,6 @@ import blake2bAsHex from './blake2b/asHex'; * blake2AsHex('abc'); // => 0xba80a53f981c4d0d * ``` */ -export default function blake2AsHex (data: Uint8Array, bitLength: number = 256): string { +export default function blake2AsHex (data: Uint8Array | string, bitLength: number = 256): string { return blake2bAsHex(data, bitLength); } diff --git a/packages/util-crypto/src/blake2/asU8a.spec.js b/packages/util-crypto/src/blake2/asU8a.spec.ts similarity index 100% rename from packages/util-crypto/src/blake2/asU8a.spec.js rename to packages/util-crypto/src/blake2/asU8a.spec.ts diff --git a/packages/util-crypto/src/blake2/asU8a.ts b/packages/util-crypto/src/blake2/asU8a.ts index b5a246510..5d8f8ba3b 100644 --- a/packages/util-crypto/src/blake2/asU8a.ts +++ b/packages/util-crypto/src/blake2/asU8a.ts @@ -6,7 +6,6 @@ import blake2bAsU8a from './blake2b/asU8a'; /** * @name blake2AsU8a - * @signature blake2AsU8a (data: Uint8Array, bitLength: number = 256): Uint8Array * @summary Creates a blake2b u8a from the input. * @description * From a `Uint8Array` input, create the blake2b and return the result as a u8a with the specified `bitLength`. @@ -19,6 +18,6 @@ import blake2bAsU8a from './blake2b/asU8a'; * blake2AsU8a('abc'); // => [0xba, 0x80, 0xa53, 0xf98, 0x1c, 0x4d, 0x0d] * ``` */ -export default function blake2AsU8a (data: Uint8Array, bitLength: number = 256, key?: Uint8Array): Uint8Array { +export default function blake2AsU8a (data: Uint8Array | string, bitLength: number = 256, key?: Uint8Array): Uint8Array { return blake2bAsU8a(data, bitLength, key); } diff --git a/packages/util-crypto/src/blake2/blake2b/asHex.spec.js b/packages/util-crypto/src/blake2/blake2b/asHex.spec.ts similarity index 100% rename from packages/util-crypto/src/blake2/blake2b/asHex.spec.js rename to packages/util-crypto/src/blake2/blake2b/asHex.spec.ts diff --git a/packages/util-crypto/src/blake2/blake2b/asHex.ts b/packages/util-crypto/src/blake2/blake2b/asHex.ts index 2fe47fb1e..72be7a790 100644 --- a/packages/util-crypto/src/blake2/blake2b/asHex.ts +++ b/packages/util-crypto/src/blake2/blake2b/asHex.ts @@ -8,7 +8,6 @@ import blake2bAsU8a from './asU8a'; /** * @name blake2bAsHex - * @signature blake2bAsHex (value: Uint8Array): string * @summary Creates a blake2b hex string from the input. * @description * From a `Uint8Array` input, create the blake2b and return the result as a hex string. @@ -21,7 +20,7 @@ import blake2bAsU8a from './asU8a'; * blake2bAsHex('abc'); // => '0xba80a53f981c4d0d6a2797b69f12f6e94c212f14685ac4b74b12bb6fdbffa2d17d87c5392aab792dc252d5de4533cc9518d38aa8dbf1925ab92386edd4009923' * ``` */ -export default function blake2bAsHex (data: Uint8Array, bitLength: number = 512): string { +export default function blake2bAsHex (data: Uint8Array | string, bitLength: number = 512): string { return u8aToHex( blake2bAsU8a(data, bitLength) ); diff --git a/packages/util-crypto/src/blake2/blake2b/asU8a.spec.js b/packages/util-crypto/src/blake2/blake2b/asU8a.spec.ts similarity index 100% rename from packages/util-crypto/src/blake2/blake2b/asU8a.spec.js rename to packages/util-crypto/src/blake2/blake2b/asU8a.spec.ts diff --git a/packages/util-crypto/src/blake2/blake2b/asU8a.ts b/packages/util-crypto/src/blake2/blake2b/asU8a.ts index d2607a3fc..94c4ec004 100644 --- a/packages/util-crypto/src/blake2/blake2b/asU8a.ts +++ b/packages/util-crypto/src/blake2/blake2b/asU8a.ts @@ -7,7 +7,6 @@ import blakejs from 'blakejs'; /** * @name blake2bAsU8a - * @signature blake2bAsU8a (value: Uint8Array): Uint8Array * @summary Creates a blake2b Uint8Array from the input. * @description * From a `Uint8Array` input, create the blake2b and return the result as a `Uint8Array`. @@ -20,6 +19,6 @@ import blakejs from 'blakejs'; * blake2bAsU8a('abc'); // => Uint8Array('508c5e8c327c14e2e1a72ba34eeb452f37458b209ed63a294d999b4c86675982') * ``` */ -export default function blake2bAsU8a (data: Uint8Array, bitLength: number = 512, key: Uint8Array | null = null): Uint8Array { +export default function blake2bAsU8a (data: Uint8Array | string, bitLength: number = 512, key: Uint8Array | null = null): Uint8Array { return blakejs.blake2b(data, key, bitLength / 8); } diff --git a/packages/util-crypto/src/keccak/asHex.spec.js b/packages/util-crypto/src/keccak/asHex.spec.ts similarity index 100% rename from packages/util-crypto/src/keccak/asHex.spec.js rename to packages/util-crypto/src/keccak/asHex.spec.ts diff --git a/packages/util-crypto/src/keccak/asHex.ts b/packages/util-crypto/src/keccak/asHex.ts index 00dae8eb9..3bbb3e2a4 100644 --- a/packages/util-crypto/src/keccak/asHex.ts +++ b/packages/util-crypto/src/keccak/asHex.ts @@ -8,7 +8,6 @@ import keccakAsU8a from './asU8a'; /** * @name keccakAsHex - * @signature keccakAsHex (value: Buffer | Uint8Array | string): string * @summary Creates a keccak hex string from the input. * @description * From either a `string` or a `Buffer` input, create the keccak and return the result as a `0x` prefixed hex string. diff --git a/packages/util-crypto/src/keccak/asU8a.spec.js b/packages/util-crypto/src/keccak/asU8a.spec.ts similarity index 100% rename from packages/util-crypto/src/keccak/asU8a.spec.js rename to packages/util-crypto/src/keccak/asU8a.spec.ts diff --git a/packages/util-crypto/src/keccak/asU8a.ts b/packages/util-crypto/src/keccak/asU8a.ts index f0cebc31a..f34c0df9b 100644 --- a/packages/util-crypto/src/keccak/asU8a.ts +++ b/packages/util-crypto/src/keccak/asU8a.ts @@ -6,7 +6,6 @@ import { keccak256 } from 'js-sha3'; /** * @name keccakAsU8a - * @signature keccakAsU8a (value: Buffer | Uint8Array | string): Uint8Array * @summary Creates a keccak Uint8Array from the input. * @description * From either a `string` or a `Buffer` input, create the keccak and return the result as a `Uint8Array`. diff --git a/packages/util-crypto/src/mnemonic/generate.spec.js b/packages/util-crypto/src/mnemonic/generate.spec.ts similarity index 100% rename from packages/util-crypto/src/mnemonic/generate.spec.js rename to packages/util-crypto/src/mnemonic/generate.spec.ts diff --git a/packages/util-crypto/src/mnemonic/generate.ts b/packages/util-crypto/src/mnemonic/generate.ts index d3276de5a..30ba5cecb 100644 --- a/packages/util-crypto/src/mnemonic/generate.ts +++ b/packages/util-crypto/src/mnemonic/generate.ts @@ -6,7 +6,6 @@ import { generateMnemonic } from 'bip39'; /** * @name mnemonicGenerate - * @signature mnemonicGenerate (): string * @summary Creates a valid mnemonic string using using [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki). * @example *
diff --git a/packages/util-crypto/src/mnemonic/toSecret.spec.js b/packages/util-crypto/src/mnemonic/toSecret.spec.ts similarity index 100% rename from packages/util-crypto/src/mnemonic/toSecret.spec.js rename to packages/util-crypto/src/mnemonic/toSecret.spec.ts diff --git a/packages/util-crypto/src/mnemonic/toSeed.ts b/packages/util-crypto/src/mnemonic/toSeed.ts index 9dec0ed86..fbf22e9bb 100644 --- a/packages/util-crypto/src/mnemonic/toSeed.ts +++ b/packages/util-crypto/src/mnemonic/toSeed.ts @@ -6,7 +6,6 @@ import toSecret from './toSecret'; /** * @name toSeed - * @signature toSeed (mnemonic: string): Uint8Array * @summary Creates a valid seed from a mnemonic input * @example *
diff --git a/packages/util-crypto/src/mnemonic/validate.spec.js b/packages/util-crypto/src/mnemonic/validate.spec.ts similarity index 100% rename from packages/util-crypto/src/mnemonic/validate.spec.js rename to packages/util-crypto/src/mnemonic/validate.spec.ts diff --git a/packages/util-crypto/src/mnemonic/validate.ts b/packages/util-crypto/src/mnemonic/validate.ts index 2ad15673e..22237bfc5 100644 --- a/packages/util-crypto/src/mnemonic/validate.ts +++ b/packages/util-crypto/src/mnemonic/validate.ts @@ -6,7 +6,6 @@ import { validateMnemonic } from 'bip39'; /** * @name mnemonicValidate - * @signature mnemonicValidate (mnemonic: string): boolean * @summary Validates a mnemonic input using [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki). * @example *
diff --git a/packages/util-crypto/src/nacl/decrypt.ts b/packages/util-crypto/src/nacl/decrypt.ts index 0f7039ef6..31768c97c 100644 --- a/packages/util-crypto/src/nacl/decrypt.ts +++ b/packages/util-crypto/src/nacl/decrypt.ts @@ -6,7 +6,6 @@ import nacl from 'tweetnacl'; /** * @name naclDecrypt - * @signature naclDecrypt (message: Uint8Array, nonce: Uint8Array, secret: Uint8Array): Uint8Array * @summary Decrypts a message using the supplied secretKey and nonce * @description * Returns an decrypted message, using the `secret` and `nonce`. diff --git a/packages/util-crypto/src/nacl/encrypt.ts b/packages/util-crypto/src/nacl/encrypt.ts index 0ecf08fc3..f5b0b7ee7 100644 --- a/packages/util-crypto/src/nacl/encrypt.ts +++ b/packages/util-crypto/src/nacl/encrypt.ts @@ -13,7 +13,6 @@ type Encrypted = { /** * @name naclEncrypt - * @signature naclEncrypt (message: Uint8Array, secret: Uint8Array, nonce?: Uint8Array): { encrypted: Uint8Array, nonce: Uint8Array } * @summary Encrypts a message using the supplied secretKey and nonce * @description * Returns an encrypted message, using the `secretKey` and `nonce`. If the `nonce` was not supplied, a random value is generated. diff --git a/packages/util-crypto/src/nacl/keypair/fromRandom.ts b/packages/util-crypto/src/nacl/keypair/fromRandom.ts index 6be4ecf5e..64dd16c92 100644 --- a/packages/util-crypto/src/nacl/keypair/fromRandom.ts +++ b/packages/util-crypto/src/nacl/keypair/fromRandom.ts @@ -8,7 +8,6 @@ import nacl from 'tweetnacl'; /** * @name naclKeypairFromRandom - * @signature naclKeypairFromRandom (): { secretKey: Uint8Array, publicKey: Uint8Array } * @summary Creates a new public/secret keypair. * @description * Returns a new generate object containing a `publicKey` & `secretKey`. diff --git a/packages/util-crypto/src/nacl/keypair/fromSecret.ts b/packages/util-crypto/src/nacl/keypair/fromSecret.ts index f74816539..bdcc4a618 100644 --- a/packages/util-crypto/src/nacl/keypair/fromSecret.ts +++ b/packages/util-crypto/src/nacl/keypair/fromSecret.ts @@ -8,7 +8,6 @@ import nacl from 'tweetnacl'; /** * @name naclKeypairFromSecret - * @signature naclKeypairFromSecret (secret: Uint8Array): { secretKey: Uint8Array, publicKey: Uint8Array } * @summary Creates a new public/secret keypair from a secret. * @description * Returns a object containing a `publicKey` & `secretKey` generated from the supplied secret. diff --git a/packages/util-crypto/src/nacl/keypair/fromSeed.ts b/packages/util-crypto/src/nacl/keypair/fromSeed.ts index e75f9a14b..43e4b7393 100644 --- a/packages/util-crypto/src/nacl/keypair/fromSeed.ts +++ b/packages/util-crypto/src/nacl/keypair/fromSeed.ts @@ -8,7 +8,6 @@ import nacl from 'tweetnacl'; /** * @name naclKeypairFromSeed - * @signature naclKeypairFromSeed (seed: Uint8Array): { secretKey: Uint8Array, publicKey: Uint8Array } * @summary Creates a new public/secret keypair from a seed. * @description * Returns a object containing a `publicKey` & `secretKey` generated from the supplied seed. diff --git a/packages/util-crypto/src/nacl/keypair/fromString.ts b/packages/util-crypto/src/nacl/keypair/fromString.ts index be112026a..4f3b8be8c 100644 --- a/packages/util-crypto/src/nacl/keypair/fromString.ts +++ b/packages/util-crypto/src/nacl/keypair/fromString.ts @@ -11,7 +11,6 @@ import fromSeed from './fromSeed'; /** * @name naclKeypairFromString - * @signature naclKeypairFromString (value: string): { secretKey: Uint8Array, publicKey: Uint8Array } * @summary Creates a new public/secret keypair from a string. * @description * Returns a object containing a `publicKey` & `secretKey` generated from the supplied string. The string is hashed and the value used as the input seed. diff --git a/packages/util-crypto/src/nacl/sign.ts b/packages/util-crypto/src/nacl/sign.ts index 68d962b03..089420589 100644 --- a/packages/util-crypto/src/nacl/sign.ts +++ b/packages/util-crypto/src/nacl/sign.ts @@ -9,7 +9,6 @@ import { assert } from '@polkadot/util/index'; /** * @name naclSign - * @signature naclSign (message: Uint8Array, secretKey: Uint8Array): Uint8Array * @summary Signs a message using the supplied secretKey * @description * Returns message signature of `message`, using the `secretKey`. diff --git a/packages/util-crypto/src/nacl/verify.ts b/packages/util-crypto/src/nacl/verify.ts index a33ac5232..efbc6d34b 100644 --- a/packages/util-crypto/src/nacl/verify.ts +++ b/packages/util-crypto/src/nacl/verify.ts @@ -6,7 +6,6 @@ import nacl from 'tweetnacl'; /** * @name naclSign - * @signature naclVerify (message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean * @summary Verifies the signature on the supplied message. * @description * Verifies the `signature` on `message` with the supplied `plublicKey`. Returns `true` on sucess, `false` otherwise. diff --git a/packages/util-crypto/src/random/asHex.spec.js b/packages/util-crypto/src/random/asHex.spec.ts similarity index 100% rename from packages/util-crypto/src/random/asHex.spec.js rename to packages/util-crypto/src/random/asHex.spec.ts diff --git a/packages/util-crypto/src/random/asHex.ts b/packages/util-crypto/src/random/asHex.ts index 309b9a4b4..3581f8801 100644 --- a/packages/util-crypto/src/random/asHex.ts +++ b/packages/util-crypto/src/random/asHex.ts @@ -8,7 +8,6 @@ import randomAsU8a from './asU8a'; /** * @name randomAsHex - * @signature randomAsHex (length?: number = 32): string * @summary Creates a hex string filled with random bytes. * @description * Returns a hex string with the specified (optional) length filled with random bytes. diff --git a/packages/util-crypto/src/random/asNumber.spec.js b/packages/util-crypto/src/random/asNumber.spec.ts similarity index 100% rename from packages/util-crypto/src/random/asNumber.spec.js rename to packages/util-crypto/src/random/asNumber.spec.ts diff --git a/packages/util-crypto/src/random/asNumber.ts b/packages/util-crypto/src/random/asNumber.ts index b8c42477e..01f77f54a 100644 --- a/packages/util-crypto/src/random/asNumber.ts +++ b/packages/util-crypto/src/random/asNumber.ts @@ -11,7 +11,6 @@ const BN_53 = new BN(0b11111111111111111111111111111111111111111111111111111); /** * @name randomAsNumber - * @signature randomAsNumber (): number * @summary Creates a random number from random bytes. * @description * Returns a random number generated from the secure bytes. diff --git a/packages/util-crypto/src/random/asU8a.spec.js b/packages/util-crypto/src/random/asU8a.spec.ts similarity index 100% rename from packages/util-crypto/src/random/asU8a.spec.js rename to packages/util-crypto/src/random/asU8a.spec.ts diff --git a/packages/util-crypto/src/random/asU8a.ts b/packages/util-crypto/src/random/asU8a.ts index b75848c24..6c4e88b7a 100644 --- a/packages/util-crypto/src/random/asU8a.ts +++ b/packages/util-crypto/src/random/asU8a.ts @@ -6,7 +6,6 @@ import nacl from 'tweetnacl'; /** * @name randomAsU8a - * @signature randomAsU8a (length?: number = 32): Uint8Array * @summary Creates a Uint8Array filled with random bytes. * @description * Returns a `Uint8Array` with the specified (optional) length filled with random bytes. diff --git a/packages/util-crypto/src/sha512/asU8a.spec.js b/packages/util-crypto/src/sha512/asU8a.spec.ts similarity index 100% rename from packages/util-crypto/src/sha512/asU8a.spec.js rename to packages/util-crypto/src/sha512/asU8a.spec.ts diff --git a/packages/util-crypto/src/sha512/asU8a.ts b/packages/util-crypto/src/sha512/asU8a.ts index 5658ec0c7..df6606ffc 100644 --- a/packages/util-crypto/src/sha512/asU8a.ts +++ b/packages/util-crypto/src/sha512/asU8a.ts @@ -6,7 +6,6 @@ import nacl from 'tweetnacl'; /** * @name sha512AsU8a - * @signature sha512AsU8a (data: Uint8Array): Uint8Array * @summary Creates sha-512 hash of the input. * @description * Returns a sha-512 `Uint8Array` from the supplied data. diff --git a/packages/util-crypto/src/xxhash/asHex.spec.js b/packages/util-crypto/src/xxhash/asHex.spec.ts similarity index 100% rename from packages/util-crypto/src/xxhash/asHex.spec.js rename to packages/util-crypto/src/xxhash/asHex.spec.ts diff --git a/packages/util-crypto/src/xxhash/asHex.ts b/packages/util-crypto/src/xxhash/asHex.ts index 4cc35c841..f32a0314a 100644 --- a/packages/util-crypto/src/xxhash/asHex.ts +++ b/packages/util-crypto/src/xxhash/asHex.ts @@ -8,7 +8,6 @@ import xxhashAsU8a from './asU8a'; /** * @name xxhashAsHex - * @signature xxhashAsHex (data: Buffer | Uint8Array | string, bitLength: number = 64): string * @summary Creates a xxhash64 hex from the input. * @description * From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash64 and return the result as a hex string with the specified `bitLength`. diff --git a/packages/util-crypto/src/xxhash/asU8a.spec.js b/packages/util-crypto/src/xxhash/asU8a.spec.ts similarity index 100% rename from packages/util-crypto/src/xxhash/asU8a.spec.js rename to packages/util-crypto/src/xxhash/asU8a.spec.ts diff --git a/packages/util-crypto/src/xxhash/asU8a.ts b/packages/util-crypto/src/xxhash/asU8a.ts index 886668ae8..8cff6912b 100644 --- a/packages/util-crypto/src/xxhash/asU8a.ts +++ b/packages/util-crypto/src/xxhash/asU8a.ts @@ -6,7 +6,6 @@ import xxhash64AsBn from './xxhash64/asBn'; /** * @name xxhashAsU8a - * @signature xxhashAsU8a (data: Buffer | Uint8Array | string, bitLength: number = 64): Uint8Array * @summary Creates a xxhash64 u8a from the input. * @description * From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash64 and return the result as a `Uint8Array` with the specified `bitLength`. diff --git a/packages/util-crypto/src/xxhash/xxhash64/asBn.spec.js b/packages/util-crypto/src/xxhash/xxhash64/asBn.spec.ts similarity index 100% rename from packages/util-crypto/src/xxhash/xxhash64/asBn.spec.js rename to packages/util-crypto/src/xxhash/xxhash64/asBn.spec.ts diff --git a/packages/util-crypto/src/xxhash/xxhash64/asBn.ts b/packages/util-crypto/src/xxhash/xxhash64/asBn.ts index 7677c83a1..39fdbcfe2 100644 --- a/packages/util-crypto/src/xxhash/xxhash64/asBn.ts +++ b/packages/util-crypto/src/xxhash/xxhash64/asBn.ts @@ -8,7 +8,6 @@ import xxhash64AsRaw from './asRaw'; /** * @name xxhash64AsBn - * @signature xxhash64AsBn (data: Buffer | Uint8Array | string, seed: number): BN * @summary Creates a xxhash BN from the input. * @description * From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash and return the result as a BN. diff --git a/packages/util-crypto/src/xxhash/xxhash64/asHex.spec.js b/packages/util-crypto/src/xxhash/xxhash64/asHex.spec.ts similarity index 100% rename from packages/util-crypto/src/xxhash/xxhash64/asHex.spec.js rename to packages/util-crypto/src/xxhash/xxhash64/asHex.spec.ts diff --git a/packages/util-crypto/src/xxhash/xxhash64/asHex.ts b/packages/util-crypto/src/xxhash/xxhash64/asHex.ts index 5c193b2d9..614ac62ae 100644 --- a/packages/util-crypto/src/xxhash/xxhash64/asHex.ts +++ b/packages/util-crypto/src/xxhash/xxhash64/asHex.ts @@ -8,7 +8,6 @@ import xxhash64AsRaw from './asRaw'; /** * @name xxhash64AsHex - * @signature xxhash64AsHex (data: Buffer | Uint8Array | string, seed: number): string * @summary Creates a xxhash hex from the input. * @description * From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash and return the result as a hex string. diff --git a/packages/util-crypto/src/xxhash/xxhash64/asRaw.spec.js b/packages/util-crypto/src/xxhash/xxhash64/asRaw.spec.ts similarity index 100% rename from packages/util-crypto/src/xxhash/xxhash64/asRaw.spec.js rename to packages/util-crypto/src/xxhash/xxhash64/asRaw.spec.ts diff --git a/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts b/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts index c93b75e6e..d4ea6c539 100644 --- a/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts +++ b/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts @@ -6,7 +6,6 @@ import xxhash64AsValue from './asValue'; /** * @name xxhash64AsRaw - * @signature xxhash64AsRaw (data: Buffer | Uint8Array | string, seed: number): string * @summary Creates a xxhash non-prefixed hex from the input. * @description * From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash and return the result as a non-prefixed hex string. diff --git a/packages/util-crypto/src/xxhash/xxhash64/asValue.spec.js b/packages/util-crypto/src/xxhash/xxhash64/asValue.spec.ts similarity index 100% rename from packages/util-crypto/src/xxhash/xxhash64/asValue.spec.js rename to packages/util-crypto/src/xxhash/xxhash64/asValue.spec.ts diff --git a/packages/util-crypto/src/xxhash/xxhash64/asValue.ts b/packages/util-crypto/src/xxhash/xxhash64/asValue.ts index 529e78eb7..d2d2af7b0 100644 --- a/packages/util-crypto/src/xxhash/xxhash64/asValue.ts +++ b/packages/util-crypto/src/xxhash/xxhash64/asValue.ts @@ -7,7 +7,6 @@ import { isBuffer, isString, u8aToBuffer } from '@polkadot/util/index'; /** * @name xxhash64AsValue - * @signature xxhash64AsValue (data: Buffer | Uint8Array | string, seed: number): number * @summary Creates a hex number from the input. * @description * From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash and return the result as a hex number diff --git a/packages/util-rlp/src/decode.spec.js b/packages/util-rlp/src/decode.spec.ts similarity index 96% rename from packages/util-rlp/src/decode.spec.js rename to packages/util-rlp/src/decode.spec.ts index dcb512004..22d766230 100644 --- a/packages/util-rlp/src/decode.spec.js +++ b/packages/util-rlp/src/decode.spec.ts @@ -21,7 +21,7 @@ describe('decode', () => { it('returns empty list for empty inputs', () => { expect( - decode([]) + decode(new Uint8Array()) ).toEqual( new Uint8Array([]) ); diff --git a/packages/util-rlp/src/decoder/index.ts b/packages/util-rlp/src/decoder/index.ts index b9ea6b992..3a50bb277 100644 --- a/packages/util-rlp/src/decoder/index.ts +++ b/packages/util-rlp/src/decoder/index.ts @@ -8,7 +8,6 @@ import internalDecode from './decode'; /** * @name decoder - * @signature decoder (input?: Uint8Array): Uint8Array | Array<*> * @summary Decodes the input RLP. * @description * From an input, decode the RLP and return the result as a `Uint8Array` or `Array`. diff --git a/packages/util-rlp/src/decoder/safeParseInt.spec.js b/packages/util-rlp/src/decoder/safeParseInt.spec.ts similarity index 100% rename from packages/util-rlp/src/decoder/safeParseInt.spec.js rename to packages/util-rlp/src/decoder/safeParseInt.spec.ts diff --git a/packages/util-rlp/src/encode.spec.js b/packages/util-rlp/src/encode.spec.ts similarity index 100% rename from packages/util-rlp/src/encode.spec.js rename to packages/util-rlp/src/encode.spec.ts diff --git a/packages/util-rlp/src/encoder/index.ts b/packages/util-rlp/src/encoder/index.ts index a815d9b94..33e9bc04c 100644 --- a/packages/util-rlp/src/encoder/index.ts +++ b/packages/util-rlp/src/encoder/index.ts @@ -8,7 +8,6 @@ import encodeU8a from './u8a'; /** * @name encoder - * @signature encoder (input: any): Uint8Array * @summary Encodes the input value into RLP. * @description * From an input, calculate the RLP and return the result as a `Uint8Array`. diff --git a/packages/util-rlp/src/encoder/length.spec.js b/packages/util-rlp/src/encoder/length.spec.ts similarity index 100% rename from packages/util-rlp/src/encoder/length.spec.js rename to packages/util-rlp/src/encoder/length.spec.ts diff --git a/packages/util-rlp/src/encoder/toU8a.spec.js b/packages/util-rlp/src/encoder/toU8a.spec.ts similarity index 100% rename from packages/util-rlp/src/encoder/toU8a.spec.js rename to packages/util-rlp/src/encoder/toU8a.spec.ts diff --git a/packages/util-rlp/src/encoder/toU8a.ts b/packages/util-rlp/src/encoder/toU8a.ts index 53f740e23..27bc0586a 100644 --- a/packages/util-rlp/src/encoder/toU8a.ts +++ b/packages/util-rlp/src/encoder/toU8a.ts @@ -36,7 +36,7 @@ const encoders: Array = [ { check: isString, fn: convertString } ]; -export default function toU8a (value: any): Uint8Array { +export default function toU8a (value?: any): Uint8Array { const encoder = encoders.find(({ check }) => check(value)); assert(encoder, 'invalid type'); diff --git a/packages/util/src/array/filter.spec.js b/packages/util/src/array/filter.spec.ts similarity index 100% rename from packages/util/src/array/filter.spec.js rename to packages/util/src/array/filter.spec.ts diff --git a/packages/util/src/array/filter.ts b/packages/util/src/array/filter.ts index ad99f265f..21f276a65 100644 --- a/packages/util/src/array/filter.ts +++ b/packages/util/src/array/filter.ts @@ -7,7 +7,6 @@ import isUndefined from '../is/undefined'; /** * @name arrayFilter - * @signature arrayFilter (array: Array, allowNulls: boolean = true): Array * @summary Filters undefined and (optionally) null values from an array * @description * Returns a new array with all `undefined` values removed. Optionally, when `allowNulls = false`, it removes the `null` values as well diff --git a/packages/util/src/assert.spec.js b/packages/util/src/assert.spec.ts similarity index 100% rename from packages/util/src/assert.spec.js rename to packages/util/src/assert.spec.ts diff --git a/packages/util/src/assert.ts b/packages/util/src/assert.ts index 474d434b4..8e4890e9c 100644 --- a/packages/util/src/assert.ts +++ b/packages/util/src/assert.ts @@ -7,9 +7,10 @@ import isFunction from './is/function'; type MessageFn = () => string; +type Falsy = null | undefined | false | 0 | ''; // No NaN type + /** * @name assert - * @signature assert (test: any, message: string | () => string, code: number = ExtError.CODES.ASSERT, data: any): void * @summary Checks for a valid test, if not ExtError is thrown. * @description * Checks that `test` is a truthy value. If value is falsy (`null`, `undefined`, `false`, ...), it throws an ExtError with the supplied `message` and an optional `code` and `data`. When `test` passes, `true` is returned. @@ -24,7 +25,7 @@ type MessageFn = () => string; * assert(false, () => 'message'); // ExtError with 'message' * ``` */ -export default function assert (test: any, message: string | MessageFn, code: number = ExtError.CODES.ASSERT, data?: any): boolean { +export default function assert (test: Falsy | T, message: string | MessageFn, code: number = ExtError.CODES.ASSERT, data?: any): test is T { if (test) { return true; } diff --git a/packages/util/src/bn/fromHex.spec.js b/packages/util/src/bn/fromHex.spec.ts similarity index 100% rename from packages/util/src/bn/fromHex.spec.js rename to packages/util/src/bn/fromHex.spec.ts diff --git a/packages/util/src/bn/fromHex.ts b/packages/util/src/bn/fromHex.ts index 439cf4449..398d3ab9b 100644 --- a/packages/util/src/bn/fromHex.ts +++ b/packages/util/src/bn/fromHex.ts @@ -6,7 +6,6 @@ import bnFromHex from '../hex/toBn'; /** * @name bnFromHex - * @signature bnFromHex (value?: string): BN * @summary Creates a BN.js bignumber object from a hex string. * @alias hex/toBn */ diff --git a/packages/util/src/bn/toBn.spec.js b/packages/util/src/bn/toBn.spec.ts similarity index 100% rename from packages/util/src/bn/toBn.spec.js rename to packages/util/src/bn/toBn.spec.ts diff --git a/packages/util/src/bn/toBn.ts b/packages/util/src/bn/toBn.ts index 112e00e76..fef7d1ba5 100644 --- a/packages/util/src/bn/toBn.ts +++ b/packages/util/src/bn/toBn.ts @@ -6,7 +6,6 @@ import BN from 'bn.js'; /** * @name bnToBn - * @signature bnToBn (value?: BN : number): BN * @summary Creates a BN value from a BN.js bignumber or number input. * @description * `null` inputs returns a `0x0` result, BN values returns the value, numnbers returns a BN representation. diff --git a/packages/util/src/bn/toHex.ts b/packages/util/src/bn/toHex.ts index 53d6c2280..ca5c2914a 100644 --- a/packages/util/src/bn/toHex.ts +++ b/packages/util/src/bn/toHex.ts @@ -17,7 +17,6 @@ interface Options extends ToBnOptions { /** * @name bnToHex - * @signature bnToHex (value?: BN, bitLength: number = -1): string * @summary Creates a hex value from a BN.js bignumber object. * @description * `null` inputs returns a `0x` result, BN values return the actual value as a `0x` prefixed hex value. Anything that is not a BN object throws an error. With `bitLength` set, it fixes the number to the specified length. diff --git a/packages/util/src/bn/toU8a.ts b/packages/util/src/bn/toU8a.ts index 72d5944a4..1efec8c41 100644 --- a/packages/util/src/bn/toU8a.ts +++ b/packages/util/src/bn/toU8a.ts @@ -14,7 +14,6 @@ interface Options extends ToBnOptions { /** * @name bnToU8a - * @signature bnToU8a (value?: BN | number, bitLength: number = -1, isLE: boolean = false): Uint8Array * @summary Creates a Uint8Array object from a BN. * @description * `null`/`undefined`/`NaN` inputs returns an empty `Uint8Array` result. `BN` input values return the actual bytes value converted to a `Uint8Array`. Optionally convert using little-endian format if `isLE` is set. diff --git a/packages/util/src/buffer/toU8a.spec.js b/packages/util/src/buffer/toU8a.spec.ts similarity index 100% rename from packages/util/src/buffer/toU8a.spec.js rename to packages/util/src/buffer/toU8a.spec.ts diff --git a/packages/util/src/buffer/toU8a.ts b/packages/util/src/buffer/toU8a.ts index 566d9937f..524c4ca25 100644 --- a/packages/util/src/buffer/toU8a.ts +++ b/packages/util/src/buffer/toU8a.ts @@ -4,7 +4,6 @@ /** * @name bufferToU8a - * @signature bufferToU8a (value?: Buffer): string * @summary Creates a Uint8Array value from a Buffer object. * @description * `null` inputs returns an empty result, `Buffer` values return the actual value as a `Uint8Array`. Anything that is not a `Buffer` object throws an error. @@ -17,7 +16,7 @@ * bufferToU8a(Buffer.from([1, 2, 3])); * ``` */ -export default function bufferToU8a (buffer?: Buffer | number[]): Uint8Array { +export default function bufferToU8a (buffer?: Buffer | number[] | null): Uint8Array { if (!buffer) { return new Uint8Array([]); } diff --git a/packages/util/src/ext/error.spec.js b/packages/util/src/ext/error.spec.ts similarity index 96% rename from packages/util/src/ext/error.spec.js rename to packages/util/src/ext/error.spec.ts index 5145989b1..e65a65b01 100644 --- a/packages/util/src/ext/error.spec.js +++ b/packages/util/src/ext/error.spec.ts @@ -59,7 +59,7 @@ describe('ExtError', () => { }); describe('stack traces', () => { - let captureStackTrace; + let captureStackTrace: any; beforeEach(() => { captureStackTrace = Error.captureStackTrace; @@ -89,7 +89,7 @@ describe('ExtError', () => { }); it('captures via stack when captureStackTrace not available', () => { - Error.captureStackTrace = null; + Error.captureStackTrace = null as any; // grrr expect( new ExtError().stack.length diff --git a/packages/util/src/ext/error.ts b/packages/util/src/ext/error.ts index cd9d18cb1..3ef29da40 100644 --- a/packages/util/src/ext/error.ts +++ b/packages/util/src/ext/error.ts @@ -18,7 +18,6 @@ function extend (that: any, name: string, value: any): void { /** * @name ExtError - * @signature ExtError (message: string = '', code: number = UNKNOWN_ERROR, value: any) * @summary Extension to the basic JS Error. * @description * The built-in JavaScript Error class is extended by adding a code to allow for Error categorization. In addition to the normal `stack`, `message`, the numeric `code` and `data` (any types) parameters are available on the object. diff --git a/packages/util/src/hex/addPrefix.spec.js b/packages/util/src/hex/addPrefix.spec.ts similarity index 100% rename from packages/util/src/hex/addPrefix.spec.js rename to packages/util/src/hex/addPrefix.spec.ts diff --git a/packages/util/src/hex/addPrefix.ts b/packages/util/src/hex/addPrefix.ts index 8ecacdbed..c3ffbc1c3 100644 --- a/packages/util/src/hex/addPrefix.ts +++ b/packages/util/src/hex/addPrefix.ts @@ -6,7 +6,6 @@ import hasPrefix from './hasPrefix'; /** * @name hexAddPrefix - * @signature hexAddPrefix (value: ?string): string * @summary Adds the `0x` prefix to string values. * @description * Returns a `0x` prefixed string from the input value. If the input is already prefixed, it is returned unchanged. @@ -19,7 +18,7 @@ import hasPrefix from './hasPrefix'; * console.log('With prefix', hexAddPrefix('0a0b12')); // => 0x0a0b12 * ``` */ -export default function hexAddPrefix (value: string | null | undefined): string { +export default function hexAddPrefix (value?: string | null): string { if (value && hasPrefix(value)) { return value; } diff --git a/packages/util/src/hex/fixLength.spec.js b/packages/util/src/hex/fixLength.spec.ts similarity index 100% rename from packages/util/src/hex/fixLength.spec.js rename to packages/util/src/hex/fixLength.spec.ts diff --git a/packages/util/src/hex/fixLength.ts b/packages/util/src/hex/fixLength.ts index 4d1acccee..3685cf23a 100644 --- a/packages/util/src/hex/fixLength.ts +++ b/packages/util/src/hex/fixLength.ts @@ -7,7 +7,6 @@ import hexStripPrefix from './stripPrefix'; /** * @name hexFixLength - * @signature hexFixLength (value: string, bitLength: number = -1, withPadding: boolean = false): string * @summary Shifts a hex string to a specific bitLength * @description * Returns a `0x` prefixed string with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length. Input values with less bits are returned as-is by default. When `withPadding` is set, shorter values are padded with `0`. diff --git a/packages/util/src/hex/hasPrefix.spec.js b/packages/util/src/hex/hasPrefix.spec.ts similarity index 95% rename from packages/util/src/hex/hasPrefix.spec.js rename to packages/util/src/hex/hasPrefix.spec.ts index 0921e8eab..e65348a73 100644 --- a/packages/util/src/hex/hasPrefix.spec.js +++ b/packages/util/src/hex/hasPrefix.spec.ts @@ -25,7 +25,7 @@ describe('hexHasPrefix', () => { it('returns false when non-string value supplied', () => { expect( - hexHasPrefix(false) + hexHasPrefix(false as any) ).toEqual(false); }); }); diff --git a/packages/util/src/hex/hasPrefix.ts b/packages/util/src/hex/hasPrefix.ts index 8cdd1bb51..13af58de4 100644 --- a/packages/util/src/hex/hasPrefix.ts +++ b/packages/util/src/hex/hasPrefix.ts @@ -6,7 +6,6 @@ import isHex from '../is/hex'; /** * @name hexHasPrefix - * @signature hexHasPrefix (value: ?string): boolean * @summary Tests for the existence of a `0x` prefix. * @description * Checks for a valid hex input value and if the start matched `0x` @@ -19,6 +18,6 @@ import isHex from '../is/hex'; * console.log('has prefix', hexHasPrefix('0x1234')); // => true * ``` */ -export default function hexHasPrefix (value: string | null | undefined): boolean { +export default function hexHasPrefix (value?: string | null): boolean { return !!(value && isHex(value, -1, true) && value.substr(0, 2) === '0x'); } diff --git a/packages/util/src/hex/stripPrefix.spec.js b/packages/util/src/hex/stripPrefix.spec.ts similarity index 100% rename from packages/util/src/hex/stripPrefix.spec.js rename to packages/util/src/hex/stripPrefix.spec.ts diff --git a/packages/util/src/hex/stripPrefix.ts b/packages/util/src/hex/stripPrefix.ts index 17646d325..875a7d34a 100644 --- a/packages/util/src/hex/stripPrefix.ts +++ b/packages/util/src/hex/stripPrefix.ts @@ -8,7 +8,6 @@ const UNPREFIX_HEX_REGEX = /^[a-fA-F0-9]+$/; /** * @name hexStripPrefix - * @signature hexStripPrefix (value: ?string): string * @summary Strips any leading `0x` prefix. * @description * Tests for the existence of a `0x` prefix, and returns the value without the prefix. Un-prefixed values are returned as-is. @@ -21,7 +20,7 @@ const UNPREFIX_HEX_REGEX = /^[a-fA-F0-9]+$/; * console.log('stripped', hexStripPrefix('0x1234')); // => 1234 * ``` */ -export default function hexStripPrefix (value: string | null | undefined): string { +export default function hexStripPrefix (value?: string | null): string { if (!value) { return ''; } diff --git a/packages/util/src/hex/toBn.ts b/packages/util/src/hex/toBn.ts index 2e218a2f2..ee6d080f1 100644 --- a/packages/util/src/hex/toBn.ts +++ b/packages/util/src/hex/toBn.ts @@ -16,7 +16,6 @@ function reverse (value: string): string { /** * @name hexToBn - * @signature hexToBn (value?: string, _options: ToBnOptions | boolean = { isLe: false, isNegative: false }): BN * @summary Creates a BN.js bignumber object from a hex string. * @description * `null` inputs returns a `BN(0)` result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the `0x` prefix) throws an error. diff --git a/packages/util/src/hex/toNumber.spec.js b/packages/util/src/hex/toNumber.spec.ts similarity index 100% rename from packages/util/src/hex/toNumber.spec.js rename to packages/util/src/hex/toNumber.spec.ts diff --git a/packages/util/src/hex/toNumber.ts b/packages/util/src/hex/toNumber.ts index 5b4095177..e21b57efb 100644 --- a/packages/util/src/hex/toNumber.ts +++ b/packages/util/src/hex/toNumber.ts @@ -6,7 +6,6 @@ import hexToBn from './toBn'; /** * @name hexToNumber - * @signature hexToNumber (value?: string): number * @summary Creates a Number value from a Buffer object. * @description * `null` inputs returns an NaN result, `hex` values return the actual value as a `Number`. @@ -19,7 +18,7 @@ import hexToBn from './toBn'; * hexToNumber('0x1234'); // => 0x1234 * ``` */ -export default function hexToNumber (value?: string): number { +export default function hexToNumber (value?: string | null): number { if (!value) { return NaN; } diff --git a/packages/util/src/hex/toU8a.spec.js b/packages/util/src/hex/toU8a.spec.ts similarity index 100% rename from packages/util/src/hex/toU8a.spec.js rename to packages/util/src/hex/toU8a.spec.ts diff --git a/packages/util/src/hex/toU8a.ts b/packages/util/src/hex/toU8a.ts index d081f2615..cfcc7bac8 100644 --- a/packages/util/src/hex/toU8a.ts +++ b/packages/util/src/hex/toU8a.ts @@ -8,7 +8,6 @@ import hexStripPrefix from './stripPrefix'; /** * @name hexToU8a - * @signature hexToU8a (value?: string, bitLength: number = -1): Uint8Array * @summary Creates a Buffer object from a hex string. * @description * `null` inputs returns an empty `Uint8Array` result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the `0x` prefix) throws an error. diff --git a/packages/util/src/index.spec.js b/packages/util/src/index.spec.ts similarity index 100% rename from packages/util/src/index.spec.js rename to packages/util/src/index.spec.ts diff --git a/packages/util/src/is/bn.spec.js b/packages/util/src/is/bn.spec.ts similarity index 100% rename from packages/util/src/is/bn.spec.js rename to packages/util/src/is/bn.spec.ts diff --git a/packages/util/src/is/bn.ts b/packages/util/src/is/bn.ts index cb8d2ea0d..d24b5af1e 100644 --- a/packages/util/src/is/bn.ts +++ b/packages/util/src/is/bn.ts @@ -6,7 +6,6 @@ import BN from 'bn.js'; /** * @name isBn - * @signature isBN (value: any): boolean * @summary Tests for a `BN` object instance. * @description * Checks to see if the input object is an instance of `BN` (bn.js). diff --git a/packages/util/src/is/boolean.spec.js b/packages/util/src/is/boolean.spec.ts similarity index 100% rename from packages/util/src/is/boolean.spec.js rename to packages/util/src/is/boolean.spec.ts diff --git a/packages/util/src/is/boolean.ts b/packages/util/src/is/boolean.ts index 2bad2e0be..e2595d4c3 100644 --- a/packages/util/src/is/boolean.ts +++ b/packages/util/src/is/boolean.ts @@ -4,7 +4,6 @@ /** * @name isBoolean - * @signature isBoolean (value: any): boolean * @summary Tests for a boolean value. * @description * Checks to see if the input value is a JavaScript boolean. diff --git a/packages/util/src/is/buffer.spec.js b/packages/util/src/is/buffer.spec.ts similarity index 100% rename from packages/util/src/is/buffer.spec.js rename to packages/util/src/is/buffer.spec.ts diff --git a/packages/util/src/is/buffer.ts b/packages/util/src/is/buffer.ts index 885d3af22..787778644 100644 --- a/packages/util/src/is/buffer.ts +++ b/packages/util/src/is/buffer.ts @@ -6,7 +6,6 @@ import isInstanceOf from './instanceOf'; /** * @name isBuffer - * @signature isBuffer (value: any): boolean * @summary Tests for a `Buffer` object instance. * @description * Checks to see if the input object is an instance of `Buffer`. diff --git a/packages/util/src/is/error.spec.js b/packages/util/src/is/error.spec.ts similarity index 100% rename from packages/util/src/is/error.spec.js rename to packages/util/src/is/error.spec.ts diff --git a/packages/util/src/is/error.ts b/packages/util/src/is/error.ts index 6723a9500..b520d4a26 100644 --- a/packages/util/src/is/error.ts +++ b/packages/util/src/is/error.ts @@ -6,7 +6,6 @@ import isInstanceOf from './instanceOf'; /** * @name isError - * @signature isError (value: any): boolean * @summary Tests for a `Error` object instance. * @description * Checks to see if the input object is an instance of `Error`. diff --git a/packages/util/src/is/function.spec.js b/packages/util/src/is/function.spec.ts similarity index 100% rename from packages/util/src/is/function.spec.js rename to packages/util/src/is/function.spec.ts diff --git a/packages/util/src/is/function.ts b/packages/util/src/is/function.ts index 619579a27..ab295fc41 100644 --- a/packages/util/src/is/function.ts +++ b/packages/util/src/is/function.ts @@ -4,7 +4,6 @@ /** * @name isFunction - * @signature isFunction (value: any): boolean * @summary Tests for a `function`. * @description * Checks to see if the input value is a JavaScript function. diff --git a/packages/util/src/is/hex.spec.js b/packages/util/src/is/hex.spec.ts similarity index 99% rename from packages/util/src/is/hex.spec.js rename to packages/util/src/is/hex.spec.ts index 158a89f83..ccfd3bec4 100644 --- a/packages/util/src/is/hex.spec.js +++ b/packages/util/src/is/hex.spec.ts @@ -19,7 +19,6 @@ describe('isHex', () => { ).toEqual(true); }); - it('returns true on hex values with String', () => { expect( isHex(new String(`0x${test}`)) diff --git a/packages/util/src/is/hex.ts b/packages/util/src/is/hex.ts index 3fdcafee8..ceaedac40 100644 --- a/packages/util/src/is/hex.ts +++ b/packages/util/src/is/hex.ts @@ -8,7 +8,6 @@ const HEX_REGEX = /^0x[a-fA-F0-9]+$/; /** * @name isHex - * @signature isHex (value: any, bitLength: number = -1): boolean * @summary Tests for a hex string. * @description * Checks to see if the input value is a `0x` prefixed hex string. Optionally (`bitLength` !== -1) checks to see if the bitLength is correct. diff --git a/packages/util/src/is/instanceOf.spec.js b/packages/util/src/is/instanceOf.spec.ts similarity index 100% rename from packages/util/src/is/instanceOf.spec.js rename to packages/util/src/is/instanceOf.spec.ts diff --git a/packages/util/src/is/instanceOf.ts b/packages/util/src/is/instanceOf.ts index 8f4a82714..62a60ae79 100644 --- a/packages/util/src/is/instanceOf.ts +++ b/packages/util/src/is/instanceOf.ts @@ -4,7 +4,6 @@ /** * @name isInstanceOf - * @signature isInstanceOf (value: any, clazz: Class): boolean * @summary Tests for a instance of a class. * @description * Checks to see if the input value is an instance of the test class. diff --git a/packages/util/src/is/ip.spec.js b/packages/util/src/is/ip.spec.ts similarity index 100% rename from packages/util/src/is/ip.spec.js rename to packages/util/src/is/ip.spec.ts diff --git a/packages/util/src/is/ip.ts b/packages/util/src/is/ip.ts index f0febe989..07b856e62 100644 --- a/packages/util/src/is/ip.ts +++ b/packages/util/src/is/ip.ts @@ -8,7 +8,6 @@ type IpTypes = 'v4' | 'v6'; /** * @name isIp - * @signature isIp (value: string, type?: 'v4' | 'v6'): boolean * @summary Tests if the value is a valid IP address * @description * Checks to see if the value is a valid IP address. Optionally check for either v4/v6 diff --git a/packages/util/src/is/null.spec.js b/packages/util/src/is/null.spec.ts similarity index 100% rename from packages/util/src/is/null.spec.js rename to packages/util/src/is/null.spec.ts diff --git a/packages/util/src/is/null.ts b/packages/util/src/is/null.ts index 86d46743f..b3a70a780 100644 --- a/packages/util/src/is/null.ts +++ b/packages/util/src/is/null.ts @@ -4,7 +4,6 @@ /** * @name isNull - * @signature isNull (value: any): boolean * @summary Tests for a `null` values. * @description * Checks to see if the input value is `null`. @@ -17,6 +16,6 @@ * console.log('isNull', isNull(null)); // => true * ``` */ -export default function isNull (value: any): value is null { +export default function isNull (value?: any): value is null { return value === null; } diff --git a/packages/util/src/is/number.spec.js b/packages/util/src/is/number.spec.ts similarity index 100% rename from packages/util/src/is/number.spec.js rename to packages/util/src/is/number.spec.ts diff --git a/packages/util/src/is/number.ts b/packages/util/src/is/number.ts index 57548e4f4..a63946ebc 100644 --- a/packages/util/src/is/number.ts +++ b/packages/util/src/is/number.ts @@ -4,7 +4,6 @@ /** * @name isNumber - * @signature isNumber (value: any): boolean * @summary Tests for a JavaScript number. * @description * Checks to see if the input value is a valid number. diff --git a/packages/util/src/is/object.spec.js b/packages/util/src/is/object.spec.ts similarity index 100% rename from packages/util/src/is/object.spec.js rename to packages/util/src/is/object.spec.ts diff --git a/packages/util/src/is/object.ts b/packages/util/src/is/object.ts index 5c843a681..ab2e55e5b 100644 --- a/packages/util/src/is/object.ts +++ b/packages/util/src/is/object.ts @@ -8,7 +8,6 @@ type ObjectIndexed = { /** * @name isObject - * @signature isObject (value: any): boolean * @summary Tests for an `object`. * @description * Checks to see if the input value is a JavaScript object. diff --git a/packages/util/src/is/observable.spec.js b/packages/util/src/is/observable.spec.ts similarity index 100% rename from packages/util/src/is/observable.spec.js rename to packages/util/src/is/observable.spec.ts diff --git a/packages/util/src/is/observable.ts b/packages/util/src/is/observable.ts index 7ea859be9..42dffe4a9 100644 --- a/packages/util/src/is/observable.ts +++ b/packages/util/src/is/observable.ts @@ -11,7 +11,6 @@ type Observable = { /** * @name isBObservable - * @signature isObservable (value: any): boolean * @summary Tests for a `Observable` object instance. * @description * Checks to see if the input object is an instance of `BN` (bn.js). diff --git a/packages/util/src/is/string.spec.js b/packages/util/src/is/string.spec.ts similarity index 100% rename from packages/util/src/is/string.spec.js rename to packages/util/src/is/string.spec.ts diff --git a/packages/util/src/is/string.ts b/packages/util/src/is/string.ts index b9c929cc3..a01ec07f6 100644 --- a/packages/util/src/is/string.ts +++ b/packages/util/src/is/string.ts @@ -4,7 +4,6 @@ /** * @name isString - * @signature isString (value: any): boolean * @summary Tests for a string. * @description * Checks to see if the input value is a JavaScript string. diff --git a/packages/util/src/is/u8a.spec.js b/packages/util/src/is/u8a.spec.ts similarity index 100% rename from packages/util/src/is/u8a.spec.js rename to packages/util/src/is/u8a.spec.ts diff --git a/packages/util/src/is/u8a.ts b/packages/util/src/is/u8a.ts index 8a539972f..10d23d314 100644 --- a/packages/util/src/is/u8a.ts +++ b/packages/util/src/is/u8a.ts @@ -6,7 +6,6 @@ import isInstanceOf from './instanceOf'; /** * @name isU8a - * @signature isU8a (value: any): boolean * @summary Tests for a `Uint8Array` object instance. * @description * Checks to see if the input object is an instance of `Uint8Array`. @@ -19,6 +18,6 @@ import isInstanceOf from './instanceOf'; * console.log('isU8a', isU8a([])); // => false * ``` */ -export default function isU8a (value: any): value is Uint8Array { +export default function isU8a (value?: any): value is Uint8Array { return isInstanceOf(value, Uint8Array); } diff --git a/packages/util/src/is/undefined.spec.js b/packages/util/src/is/undefined.spec.ts similarity index 100% rename from packages/util/src/is/undefined.spec.js rename to packages/util/src/is/undefined.spec.ts diff --git a/packages/util/src/is/undefined.ts b/packages/util/src/is/undefined.ts index 0028ebc10..80e19cbfb 100644 --- a/packages/util/src/is/undefined.ts +++ b/packages/util/src/is/undefined.ts @@ -4,7 +4,6 @@ /** * @name isUndefined - * @signature isUndefined (value: any): boolean * @summary Tests for a `undefined` values. * @description * Checks to see if the input value is `undefined`. @@ -17,6 +16,6 @@ * console.log('isUndefined', isUndefined(void(0))); // => true * ``` */ -export default function isUndefined (value: any): value is undefined { +export default function isUndefined (value?: any): value is undefined { return typeof value === 'undefined'; } diff --git a/packages/util/src/logger.spec.js b/packages/util/src/logger.spec.ts similarity index 94% rename from packages/util/src/logger.spec.js rename to packages/util/src/logger.spec.ts index 5db6f0d88..f7a0a1fe0 100644 --- a/packages/util/src/logger.spec.js +++ b/packages/util/src/logger.spec.ts @@ -6,12 +6,12 @@ import { logger } from './index'; import { format } from './logger'; describe('logger', () => { - let dateMatch; - let prefixMatch; - let l; - let ln; - let spy; - let oldEnv; + let dateMatch: any; + let prefixMatch: any; + let l: any; + let ln: any; + let spy: any; + let oldEnv: any; beforeEach(() => { oldEnv = process.env; @@ -28,8 +28,7 @@ describe('logger', () => { log: jest.fn(), warn: jest.fn() }; - global.console = spy; - + (global as any).console = spy; dateMatch = expect.stringMatching(/20[0-9]{2}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}/); prefixMatch = expect.stringMatching(/TEST:/); @@ -143,7 +142,7 @@ describe('logger', () => { }); it('does not debug log when no process.env', () => { - process.env = void 0; + process.env = void 0 as any; l = logger('test'); l.debug('test'); diff --git a/packages/util/src/logger.ts b/packages/util/src/logger.ts index 95c917be5..1121148dd 100644 --- a/packages/util/src/logger.ts +++ b/packages/util/src/logger.ts @@ -89,7 +89,6 @@ function noop (...values: Logger$Data): void { /** * @name Logger - * @signature logger (type: string): Logger * @summary Creates a consistent log interface for messages * @description * Returns a `Logger` that has `.log`, `.error`, `.warn` and `.debug` (controlled with environment `DEBUG=typeA,typeB`) methods. Logging is done with a consistent prefix (type of logger, date) followed by the actual message using the underlying console. diff --git a/packages/util/src/number/toHex.spec.js b/packages/util/src/number/toHex.spec.ts similarity index 100% rename from packages/util/src/number/toHex.spec.js rename to packages/util/src/number/toHex.spec.ts diff --git a/packages/util/src/number/toHex.ts b/packages/util/src/number/toHex.ts index 4f6b9dd43..7b635baa1 100644 --- a/packages/util/src/number/toHex.ts +++ b/packages/util/src/number/toHex.ts @@ -8,7 +8,6 @@ import isUndefined from '../is/undefined'; /** * @name numberToHex - * @signature numberToHex (value?: number): string * @summary Creates a hex value from a number. * @description * `null`/`undefined`/`NaN` inputs returns an empty `0x` result. `number` input values return the actual bytes value converted to a `hex`. With `bitLength` set, it converts the number to the equivalent size. @@ -22,7 +21,7 @@ import isUndefined from '../is/undefined'; * numberToHex(0x1234, 32); // => 0x00001234 * ``` */ -export default function numberToHex (value?: number, bitLength: number = -1): string { +export default function numberToHex (value?: number | null, bitLength: number = -1): string { if (isUndefined(value) || isNull(value) || isNaN(value)) { return '0x'; } diff --git a/packages/util/src/number/toU8a.spec.js b/packages/util/src/number/toU8a.spec.ts similarity index 100% rename from packages/util/src/number/toU8a.spec.js rename to packages/util/src/number/toU8a.spec.ts diff --git a/packages/util/src/number/toU8a.ts b/packages/util/src/number/toU8a.ts index 48a97a2fb..5be790811 100644 --- a/packages/util/src/number/toU8a.ts +++ b/packages/util/src/number/toU8a.ts @@ -7,7 +7,6 @@ import numberToHex from './toHex'; /** * @name numberToU8a - * @signature numberToU8a (value?: number, bitLenght: number = -1): Uint8Array * @summary Creates a Uint8Array object from a number. * @description * `null`/`undefined`/`NaN` inputs returns an empty `Uint8Array` result. `number` input values return the actual bytes value converted to a `Uint8Array`. With `bitLength`, it converts the value to the equivalent size. @@ -20,7 +19,7 @@ import numberToHex from './toHex'; * numberToU8a(0x1234); // => [0x12, 0x34] * ``` */ -export default function numberToU8a (value?: number, bitLength: number = -1): Uint8Array { +export default function numberToU8a (value?: number | null, bitLength: number = -1): Uint8Array { if (!value || isNaN(value)) { return new Uint8Array([]); } diff --git a/packages/util/src/polyfill/textDecoder.spec.js b/packages/util/src/polyfill/textDecoder.spec.ts similarity index 62% rename from packages/util/src/polyfill/textDecoder.spec.js rename to packages/util/src/polyfill/textDecoder.spec.ts index fa7f182e9..b2c62a814 100644 --- a/packages/util/src/polyfill/textDecoder.spec.js +++ b/packages/util/src/polyfill/textDecoder.spec.ts @@ -3,27 +3,27 @@ // of the Apache-2.0 license. See the LICENSE file for details. describe('TextDecoder', () => { - let origTD; + let origTD: TextDecoder; beforeEach(() => { - origTD = global.TextDecoder; + origTD = (global as any).TextDecoder; }); afterEach(() => { - global.TextDecoder = origTD; + (global as any).TextDecoder = origTD; }); it('polyfills with no exceptions (without TextDecoder)', () => { - global.TextDecoder = null; + (global as any).TextDecoder = null; expect(require('./textDecoder')).toBeDefined(); - expect(global.TextDecoder).toBeDefined(); + expect((global as any).TextDecoder).toBeDefined(); }); it('polyfills with no exceptions (with TextDecoder)', () => { - global.TextDecoder = require('util').TextDecoder; + (global as any).TextDecoder = require('util').TextDecoder; expect(require('./textDecoder')).toBeDefined(); - expect(global.TextDecoder).toBeDefined(); + expect((global as any).TextDecoder).toBeDefined(); }); }); diff --git a/packages/util/src/polyfill/textEncoder.spec.js b/packages/util/src/polyfill/textEncoder.spec.ts similarity index 62% rename from packages/util/src/polyfill/textEncoder.spec.js rename to packages/util/src/polyfill/textEncoder.spec.ts index bd583f0cb..ef09a7ad9 100644 --- a/packages/util/src/polyfill/textEncoder.spec.js +++ b/packages/util/src/polyfill/textEncoder.spec.ts @@ -3,27 +3,27 @@ // of the Apache-2.0 license. See the LICENSE file for details. describe('TextEncoder', () => { - let origTE; + let origTE: TextEncoder; beforeEach(() => { - origTE = global.TextEncoder; + origTE = (global as any).TextEncoder; }); afterEach(() => { - global.TextEncoder = origTE; + (global as any).TextEncoder = origTE; }); it('polyfills with no exceptions (without TextEncoder)', () => { - global.TextEncoder = null; + (global as any).TextEncoder = null; expect(require('./textEncoder')).toBeDefined(); - expect(global.TextEncoder).toBeDefined(); + expect((global as any).TextEncoder).toBeDefined(); }); it('polyfills with no exceptions (with TextEncoder)', () => { - global.TextEncoder = require('util').TextEncoder; + (global as any).TextEncoder = require('util').TextEncoder; expect(require('./textEncoder')).toBeDefined(); - expect(global.TextEncoder).toBeDefined(); + expect((global as any).TextEncoder).toBeDefined(); }); }); diff --git a/packages/util/src/promisify.spec.js b/packages/util/src/promisify.spec.ts similarity index 75% rename from packages/util/src/promisify.spec.js rename to packages/util/src/promisify.spec.ts index da9480024..b02135b13 100644 --- a/packages/util/src/promisify.spec.js +++ b/packages/util/src/promisify.spec.ts @@ -6,7 +6,7 @@ import { promisify } from './index'; describe('promisify', () => { it('handles functions with no parameters (resolve)', () => { - const fn = (cb) => cb(null, [true, 'test', 1]); + const fn = (cb: Function) => cb(null, [true, 'test', 1]); return promisify(null, fn).then((result) => { expect(result).toEqual([true, 'test', 1]); @@ -14,7 +14,7 @@ describe('promisify', () => { }); it('handles functions with no parameters (reject)', () => { - const fn = (cb) => cb(new Error('test reject')); + const fn = (cb: Function) => cb(new Error('test reject')); return promisify(null, fn).catch((error) => { expect(error.message).toEqual('test reject'); @@ -22,7 +22,7 @@ describe('promisify', () => { }); it('handles functions with parameters (resolve)', () => { - const fn = (a, b, c, cb) => cb(null, [a, b, c]); + const fn = (a: any, b: any, c: any, cb: Function) => cb(null, [a, b, c]); return promisify(null, fn, 2, false, null).then((result) => { expect(result).toEqual([2, false, null]); @@ -30,7 +30,7 @@ describe('promisify', () => { }); it('handles functions with parameters (reject)', () => { - const fn = (a, b, c, cb) => cb(new Error(`test reject: ${a},${b},${c}`)); + const fn = (a: any, b: any, c: any, cb: Function) => cb(new Error(`test reject: ${a},${b},${c}`)); return promisify(null, fn, 3, 'string', true).catch((error) => { expect(error.message).toEqual('test reject: 3,string,true'); @@ -40,7 +40,8 @@ describe('promisify', () => { it('applies the correct this argument', () => { const self = { something: 'something' }; - return promisify(self, function (cb) { + return promisify(self, function (cb: Function) { + // @ts-ignore expect(this).toEqual(self); cb(); }); diff --git a/packages/util/src/promisify.ts b/packages/util/src/promisify.ts index bd0e323fd..1b6cfd41f 100644 --- a/packages/util/src/promisify.ts +++ b/packages/util/src/promisify.ts @@ -4,7 +4,6 @@ /** * @name promisify - * @signature function promisify (this: ?Object, fn: Function, ...params: Array): Promise * @summary Wraps an async callback into a `Promise` * @description * Wraps the supplied async function `fn` that has a standard JS callback `(error: Error, result: any)` into a `Promise`, passing the supplied parameters. When `error` is set, the Promise is rejected, else the Promise resolves with the `result` value. diff --git a/packages/util/src/string/camelCase.spec.js b/packages/util/src/string/camelCase.spec.ts similarity index 91% rename from packages/util/src/string/camelCase.spec.js rename to packages/util/src/string/camelCase.spec.ts index b43d4baa0..b61eccab6 100644 --- a/packages/util/src/string/camelCase.spec.js +++ b/packages/util/src/string/camelCase.spec.ts @@ -5,7 +5,7 @@ import { stringCamelCase } from './index'; describe('stringCamelCase', () => { - it("works correctly", () => { + it('works correctly', () => { expect( stringCamelCase('Snake_case') ).toBe('snakeCase'); diff --git a/packages/util/src/string/lowerFirst.spec.js b/packages/util/src/string/lowerFirst.spec.ts similarity index 83% rename from packages/util/src/string/lowerFirst.spec.js rename to packages/util/src/string/lowerFirst.spec.ts index 48b5cb868..ae741ccf1 100644 --- a/packages/util/src/string/lowerFirst.spec.js +++ b/packages/util/src/string/lowerFirst.spec.ts @@ -17,15 +17,15 @@ describe('stringLowerFirst', () => { ).toBe('abc'); }); - it('returns undefined as undefined', () => { + it('returns undefined as empty', () => { expect( stringLowerFirst() - ).toBe(undefined); + ).toBe(''); }); - it('returns null as null', () => { + it('returns null as empty', () => { expect( stringLowerFirst(null) - ).toBe(null); + ).toBe(''); }); }); diff --git a/packages/util/src/string/lowerFirst.ts b/packages/util/src/string/lowerFirst.ts index bcd812d5e..3afe4f65e 100644 --- a/packages/util/src/string/lowerFirst.ts +++ b/packages/util/src/string/lowerFirst.ts @@ -2,12 +2,8 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import isNull from '../is/null'; -import isUndefined from '../is/undefined'; - /** * @name stringLowerFirst - * @signature stringLowerFirst (_value: string): string * @summary Lowercase the first letter of a string * @description * Lowercase the first letter of a string @@ -20,10 +16,10 @@ import isUndefined from '../is/undefined'; * stringLowerFirst('ABC'); // => 'aBC' * ``` */ -export default function stringLowerFirst (_value: string): string { - if (isNull(_value) || isUndefined(_value)) { - return _value; +export default function stringLowerFirst (value?: string | null): string { + if (!value) { + return ''; } - return _value.charAt(0).toLowerCase() + _value.slice(1); + return value.charAt(0).toLowerCase() + value.slice(1); } diff --git a/packages/util/src/string/shorten.spec.js b/packages/util/src/string/shorten.spec.ts similarity index 100% rename from packages/util/src/string/shorten.spec.js rename to packages/util/src/string/shorten.spec.ts diff --git a/packages/util/src/string/shorten.ts b/packages/util/src/string/shorten.ts index 3755026e3..f6f59fa43 100644 --- a/packages/util/src/string/shorten.ts +++ b/packages/util/src/string/shorten.ts @@ -4,7 +4,6 @@ /** * @name stringShorten - * @signature stringShorten (value: any, 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 @@ -17,7 +16,7 @@ * stringShorten('1234567890', 2); // => 12..90 * ``` */ -export default function stringShorten (_value: any, prefixLength: number = 6): string { +export default function stringShorten (_value?: any, prefixLength: number = 6): string { const value = `${_value}`; if (value.length <= 2 + 2 * prefixLength) { diff --git a/packages/util/src/string/toU8a.spec.js b/packages/util/src/string/toU8a.spec.ts similarity index 100% rename from packages/util/src/string/toU8a.spec.js rename to packages/util/src/string/toU8a.spec.ts diff --git a/packages/util/src/string/toU8a.ts b/packages/util/src/string/toU8a.ts index 00c909cce..d3c7637f8 100644 --- a/packages/util/src/string/toU8a.ts +++ b/packages/util/src/string/toU8a.ts @@ -24,7 +24,6 @@ try { /** * @name stringToU8a - * @signature stringToU8a (value?: string): UInt8Array * @summary Creates a Uint8Array object from a utf-8 string. * @description * String input values return the actual encoded `UInt8Array`. `null` or `undefined` values returns an empty encoded array. diff --git a/packages/util/src/string/upperFirst.spec.js b/packages/util/src/string/upperFirst.spec.ts similarity index 83% rename from packages/util/src/string/upperFirst.spec.js rename to packages/util/src/string/upperFirst.spec.ts index e41db0370..ba6920ccf 100644 --- a/packages/util/src/string/upperFirst.spec.js +++ b/packages/util/src/string/upperFirst.spec.ts @@ -17,15 +17,15 @@ describe('stringUpperFirst', () => { ).toBe('Abc'); }); - it('returns undefined as undefined', () => { + it('returns undefined as empty', () => { expect( stringUpperFirst() - ).toBe(undefined); + ).toBe(''); }); - it('returns null as null', () => { + it('returns null as empty', () => { expect( stringUpperFirst(null) - ).toBe(null); + ).toBe(''); }); }); diff --git a/packages/util/src/string/upperFirst.ts b/packages/util/src/string/upperFirst.ts index 54adbfd8a..2dbbbdb36 100644 --- a/packages/util/src/string/upperFirst.ts +++ b/packages/util/src/string/upperFirst.ts @@ -2,12 +2,8 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import isNull from '../is/null'; -import isUndefined from '../is/undefined'; - /** * @name stringUpperFirst - * @signature stringUpperFirst (_value: string): string * @summary Lowercase the first letter of a string * @description * Lowercase the first letter of a string @@ -20,10 +16,10 @@ import isUndefined from '../is/undefined'; * stringUpperFirst('abc'); // => 'Abc' * ``` */ -export default function stringUpperFirst (_value: string): string { - if (isNull(_value) || isUndefined(_value)) { - return _value; +export default function stringUpperFirst (value?: string | null): string { + if (!value) { + return ''; } - return _value.charAt(0).toUpperCase() + _value.slice(1); + return value.charAt(0).toUpperCase() + value.slice(1); } diff --git a/packages/util/src/syncify.spec.js b/packages/util/src/syncify.spec.ts similarity index 100% rename from packages/util/src/syncify.spec.js rename to packages/util/src/syncify.spec.ts diff --git a/packages/util/src/u8a/concat.spec.js b/packages/util/src/u8a/concat.spec.ts similarity index 100% rename from packages/util/src/u8a/concat.spec.js rename to packages/util/src/u8a/concat.spec.ts diff --git a/packages/util/src/u8a/concat.ts b/packages/util/src/u8a/concat.ts index 503ff94d0..3207e92fe 100644 --- a/packages/util/src/u8a/concat.ts +++ b/packages/util/src/u8a/concat.ts @@ -6,7 +6,6 @@ import u8aToU8a from './toU8a'; /** * @name u8aConcat - * @signature u8aConcat (...values: Array): Uint8Array * @summary Creates a concatenated Uint8Array from the inputs. * @description * Concatenates the input arrays into a single `UInt8Array`. diff --git a/packages/util/src/u8a/fixLength.spec.js b/packages/util/src/u8a/fixLength.spec.ts similarity index 100% rename from packages/util/src/u8a/fixLength.spec.js rename to packages/util/src/u8a/fixLength.spec.ts diff --git a/packages/util/src/u8a/fixLength.ts b/packages/util/src/u8a/fixLength.ts index d1169d980..bad26f116 100644 --- a/packages/util/src/u8a/fixLength.ts +++ b/packages/util/src/u8a/fixLength.ts @@ -4,7 +4,6 @@ /** * @name u8aFixLength - * @signature u8aFixLength (value: string, bitLength: number = -1, withPadding: boolean = false): string * @summary Shifts a Uint8Array to a specific bitLength * @description * Returns a uint8Array with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length. diff --git a/packages/util/src/u8a/toBn.ts b/packages/util/src/u8a/toBn.ts index 6aca2e750..07e52687a 100644 --- a/packages/util/src/u8a/toBn.ts +++ b/packages/util/src/u8a/toBn.ts @@ -10,7 +10,6 @@ import { ToBnOptions } from '../types'; /** * @name u8aToBn - * @signature u8aToHex (value?: Uint8Array, options: ToBnOptions | boolean = { isLe: true, isNegative: false }): BN * @summary Creates a BN from a Uint8Array object. * @description * `UInt8Array` input values return the actual BN. `null` or `undefined` values returns an `0x0` value. diff --git a/packages/util/src/u8a/toBuffer.spec.js b/packages/util/src/u8a/toBuffer.spec.ts similarity index 100% rename from packages/util/src/u8a/toBuffer.spec.js rename to packages/util/src/u8a/toBuffer.spec.ts diff --git a/packages/util/src/u8a/toBuffer.ts b/packages/util/src/u8a/toBuffer.ts index 24edb25db..1cf99b4f6 100644 --- a/packages/util/src/u8a/toBuffer.ts +++ b/packages/util/src/u8a/toBuffer.ts @@ -4,7 +4,6 @@ /** * @name u8aToBuffer - * @signature u8aToBuffer (value?: UInt8Array): Buffer * @summary Creates a Buffer object from a hex string. * @description * `null` inputs returns an empty `Buffer` result. `UInt8Array` input values return the actual bytes value converted to a `Buffer`. Anything that is not a `UInt8Array` throws an error. @@ -17,7 +16,7 @@ * console.log('Buffer', u8aToBuffer('0x123480001f')); * ``` */ -export default function u8aToBuffer (value?: Uint8Array): Buffer { +export default function u8aToBuffer (value?: Uint8Array | null): Buffer { if (!value) { return Buffer.from([]); } diff --git a/packages/util/src/u8a/toHex.spec.js b/packages/util/src/u8a/toHex.spec.ts similarity index 93% rename from packages/util/src/u8a/toHex.spec.js rename to packages/util/src/u8a/toHex.spec.ts index 02e31c104..88b7455bb 100644 --- a/packages/util/src/u8a/toHex.spec.js +++ b/packages/util/src/u8a/toHex.spec.ts @@ -13,7 +13,7 @@ describe('u8aToHex', () => { it('returns empty as "" (unprefixed)', () => { expect( - u8aToHex('', -1, false) + u8aToHex(null, -1, false) ).toEqual(''); }); @@ -45,7 +45,7 @@ describe('u8aToHex', () => { it('returns the hex value where allowed < max', () => { expect( u8aToHex( - new Uint8Array([128, 0, 10, 11], 64) + new Uint8Array(Uint8Array.from([128, 0, 10, 11]), 64) ) ).toEqual('0x80000a0b'); }); diff --git a/packages/util/src/u8a/toHex.ts b/packages/util/src/u8a/toHex.ts index 56a8575ea..954412f3d 100644 --- a/packages/util/src/u8a/toHex.ts +++ b/packages/util/src/u8a/toHex.ts @@ -6,7 +6,6 @@ const ALPHABET = '0123456789abcdef'; /** * @name u8aToHex - * @signature u8aToHex (value?: UInt8Array): string * @summary Creates a hex string from a Uint8Array object. * @description * `UInt8Array` input values return the actual hex string. `null` or `undefined` values returns an `0x` string. diff --git a/packages/util/src/u8a/toString.spec.js b/packages/util/src/u8a/toString.spec.ts similarity index 100% rename from packages/util/src/u8a/toString.spec.js rename to packages/util/src/u8a/toString.spec.ts diff --git a/packages/util/src/u8a/toString.ts b/packages/util/src/u8a/toString.ts index c217aaa81..1874c5c5c 100644 --- a/packages/util/src/u8a/toString.ts +++ b/packages/util/src/u8a/toString.ts @@ -20,7 +20,6 @@ try { /** * @name u8aToString - * @signature u8aToString (value?: UInt8Array): string * @summary Creates a utf-8 string from a Uint8Array object. * @description * `UInt8Array` input values return the actual decoded utf-8 string. `null` or `undefined` values returns an empty string. @@ -33,7 +32,7 @@ try { * u8aToString(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0x6f])); // hello * ``` */ -export default function u8aToString (value?: Uint8Array): string { +export default function u8aToString (value?: Uint8Array | null): string { if (!value || !value.length) { return ''; } diff --git a/packages/util/src/u8a/toU8a.spec.js b/packages/util/src/u8a/toU8a.spec.ts similarity index 100% rename from packages/util/src/u8a/toU8a.spec.js rename to packages/util/src/u8a/toU8a.spec.ts diff --git a/packages/util/src/u8a/toU8a.ts b/packages/util/src/u8a/toU8a.ts index 08881a3e9..125d57410 100644 --- a/packages/util/src/u8a/toU8a.ts +++ b/packages/util/src/u8a/toU8a.ts @@ -11,7 +11,6 @@ import stringToU8a from '../string/toU8a'; /** * @name u8aToU8a - * @signature u8aToU8a (value?: Array | Buffer | Uint8Array | string | null): Uint8Array * @summary Creates a Uint8Array value from a Uint8Array bignumber or hex input. * @description * `null` inputs returns a `[]` result, Uint8Array values returns the value, hex strings returns a Uint8Array representation. diff --git a/yarn.lock b/yarn.lock index cefe0c5b2..e155ea9ba 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1444,6 +1444,14 @@ resolved "https://registry.yarnpkg.com/@types/node/-/node-10.12.18.tgz#1d3ca764718915584fcd9f6344621b7672665c67" integrity sha512-fh+pAqt4xRzPfqA6eh3Z2y6fyZavRIumvjhaCL753+TVkGKGhpPeyrJG2JftD0T9q4GF00KjefsQ+PQNDdWQaQ== +"@types/rimraf@^2.0.2": + version "2.0.2" + resolved "https://registry.yarnpkg.com/@types/rimraf/-/rimraf-2.0.2.tgz#7f0fc3cf0ff0ad2a99bb723ae1764f30acaf8b6e" + integrity sha512-Hm/bnWq0TCy7jmjeN5bKYij9vw5GrDFWME4IuxV08278NtU/VdGbzsBohcCUJ7+QMqmUq5hpRKB39HeQWJjztQ== + dependencies: + "@types/glob" "*" + "@types/node" "*" + "@types/shelljs@^0.8.0": version "0.8.1" resolved "https://registry.yarnpkg.com/@types/shelljs/-/shelljs-0.8.1.tgz#133e874b5fb816a2e1c8647839c82d76760b1191"