seed-words 1.0.0 → 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/README.md

@@ -1,8 +1,12 @@
 <a name="module_seed-words"></a>
 
 ## seed-words
-Seed Words is a list of English words to be used in mnemonic seed phrases. There are a total of 256 x 256 = 65536 words. They can be used to represent any arbitrary 2 byte array with a single
     if (initResult === false) {
         console.log("error initializing");
     } else {
        console.log("initialized");
     }
+Seed Words is a list of English words to be used in mnemonic seed phrases. There are a total of 256 x 256 = 65536 words. They can be used to represent any arbitrary 2 byte array with a single
 
+**Example**  
+```js
+Requires Node.js version v20.18.1 or higher
     if (initResult === false) {
         console.log("error initializing");
     } else {
        console.log("initialized");
     }
+```
 
 * [seed-words](#module_seed-words)
     * [~initialize()](#module_seed-words..initialize) ⇒ <code>Promise.&lt;boolean&gt;</code>

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.0",
+  "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",
@@ -17,7 +18,7 @@
     "seeds",
     "quantumcoin"
   ],
-  "author": "Quantum Coin Community",
+  "author": "QuantumCoin Community",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/quantumcoinproject/seed-words/issues"