[doge-seed] Add types

This commit is contained in:
Dimitri Benin 2019-01-13 13:59:46 +01:00
parent 3a69de74e2
commit 151938df46
4 changed files with 46 additions and 0 deletions

View File

@ -0,0 +1,4 @@
import dogeSeed = require('doge-seed');
dogeSeed(); // $ExpectType string
dogeSeed(128); // $ExpectType string

18
types/doge-seed/index.d.ts vendored Normal file
View File

@ -0,0 +1,18 @@
// Type definitions for doge-seed 1.0
// Project: https://github.com/lukechilds/doge-seed#readme
// Definitions by: BendingBender <https://github.com/BendingBender>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
export = dogeSeed;
/**
* Generates a cryptographically secure mnemonic seed phrase with added dankness.
* The first four words will be a randomly generated Doge-like sentence.
*
* The seed phrases are fully valid checksummed BIP39 seeds. They can be used with any cryptocurrency
* and can be imported into any BIP39 compliant wallet.
*
* @param bits The number of bits to derive a BIP39 mnemonic from. Default: `128`.
* @returns A BIP39 mnemonic seed phrase.
*/
declare function dogeSeed(bits?: 128 | 160 | 192 | 224 | 256): string;

View File

@ -0,0 +1,23 @@
{
"compilerOptions": {
"module": "commonjs",
"lib": [
"es6"
],
"noImplicitAny": true,
"noImplicitThis": true,
"strictNullChecks": true,
"strictFunctionTypes": true,
"baseUrl": "../",
"typeRoots": [
"../"
],
"types": [],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts",
"doge-seed-tests.ts"
]
}

View File

@ -0,0 +1 @@
{ "extends": "dtslint/dt.json" }