seed-words 1.0.1 → 1.0.2

package/BUILD.md

@@ -0,0 +1,7 @@
+## Generating Typescript Definitions
+
+    npx -p typescript tsc seedwords.js --declaration --allowJs --emitDeclarationOnly --outDir dist
+
+## Generating README.md
+
+    jsdoc2md seedwords.js >README.md

package/dist/seedwords.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The initialize function has to be called before attempting to invoke any other function. This function should be called only once.
+ *
+ * @async
+ * @function initialize
+ * @return {Promise<boolean>} Returns a promise of type boolean; true if the initialization succeeded, else false.
+ */
+export function initialize(): Promise<boolean>;
+/**
+ * The getWordListFromSeedArray function returns the word list corresponding to a byte array.
+ *
+ * @function getWordListFromSeedArray
+ * @param {array} seedArray - An array of bytes. This array should have an even number of elements.
+ * @return {array} Returns the array of words (string) corresponding to the input seed array. Returns null on failure. This function can fail if the seedArray is invalid or initialize() hasn't been called.
+ */
+export function getWordListFromSeedArray(seedArray: any[]): any[];
+/**
+ * The doesSeedWordExist function returns the word list corresponding to a byte array.
+ *
+ * @function doesSeedWordExist
+ * @param {string} word - A seed word to find whether it exists in the list or not.
+ * @return {boolean} Returns true if the seed word exists. Returns false if it doesn't exist. Returns null on failure. This function can fail if initialize() function was not called.
+ */
+export function doesSeedWordExist(word: string): boolean;
+/**
+ * The getAllSeedWords function returns all the seed words in an array.
+ *
+ * @function getAllSeedWords
+ * @return {array} Returns an array with the list of all seed words.
+ */
+export function getAllSeedWords(): any[];
+/**
+ * The getSeedArrayFromWordList function a byte array that corresponds to the seed word list.
+ *
+ * @function getSeedArrayFromWordList
+ * @param {array} wordList - An array of seed words.
+ * @return {array} Returns an array of bytes that correspond to the wordList. Returns null on failure. This function can fail if initialize() function was not called or the word doesn't exist.
+ */
+export function getSeedArrayFromWordList(wordList: any[]): any[];

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "seed-words",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Seed Words JS SDK",
   "main": "seedwords.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "npx -p typescript tsc seedwords.js --declaration --allowJs --emitDeclarationOnly --outDir dist && jsdoc2md seedwords.js >README.md"
   },
   "repository": {
     "type": "git",

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  // Change this to match your project
+  "include": ["seedwords.js"],
+  "compilerOptions": {
+    // Tells TypeScript to read JS files, as
+    // normally they are ignored as source files
+    "allowJs": true,
+    // Generate d.ts files
+    "declaration": true,
+    // This compiler run should
+    // only output d.ts files
+    "emitDeclarationOnly": true,
+    // Types should go into this directory.
+    // Removing this would place the .d.ts files
+    // next to the .js files
+    "outDir": "dist",
+    // go to js file when using IDE functions like
+    // "Go to Definition" in VSCode
+    "declarationMap": true
+  }
+}