Merge pull request #7 from forinda/development

Update build

.gitignore

@@ -40,12 +40,12 @@ bower_components
 .lock-wscript
 
 # Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
+# build/Release
 
 # Dependency directories
 node_modules/
 jspm_packages/
-build/
+# build/
 dist/
 
 # Snowpack dependency directory (https://snowpack.dev/)

.npmignore

@@ -1,3 +1,3 @@
-.git
+.github
 node_modules
 src

build/index.d.ts

@@ -0,0 +1,12 @@
+import * as shuffle from './utils';
+export default shuffle;
+export declare const alphabets: typeof shuffle.alphabets, capitalize: typeof shuffle.capitalize, generateRandomString: typeof shuffle.generateRandomString, lowerCaseLetters: string[], shuffleString: typeof shuffle.shuffleString, symbols: string[], upperCaseLetters: string[];
+export declare type AlphabetType = typeof alphabets;
+export declare type CapitalizeType = typeof capitalize;
+export declare type LowerCaseLetterType = typeof lowerCaseLetters;
+export declare type UpperCaseLetterType = typeof upperCaseLetters;
+export declare type NumberType = typeof symbols;
+export declare type SymbolType = typeof symbols;
+export declare type GenerateRandomstringType = typeof generateRandomString;
+export declare type ShuffleStringType = typeof shuffleString;
+//# sourceMappingURL=index.d.ts.map

build/utils/alphabet.d.ts

@@ -0,0 +1,22 @@
+/**
+ *
+ * A function that generates alphabet characters and symbols
+ *
+ */
+declare function alphabets(): {
+    alphabet: string[];
+    lowerCaseLetters: string[];
+    upperCaseLetters: string[];
+    numbers: string[];
+    symbols: string[];
+};
+export declare const lowerCaseLetters: string[], alphabet: string[], upperCaseLetters: string[], numbers: string[], symbols: string[];
+export { alphabets };
+export default alphabets;
+export declare type LowerCaseLetterType = typeof lowerCaseLetters;
+export declare type UpperCaseLetterType = typeof upperCaseLetters;
+export declare type NumberType = typeof numbers;
+export declare type SymbolType = typeof symbols;
+export declare type AlphabetType = typeof alphabet;
+export declare type AlphabetTypeWithLowerCase = LowerCaseLetterType & UpperCaseLetterType & NumberType & SymbolType;
+//# sourceMappingURL=alphabet.d.ts.map

build/utils/capitalize.d.ts

@@ -0,0 +1,12 @@
+/**
+ *
+ * A function that capitalizes the first letter of a string
+ * @param {string} text
+ * @returns {string} text
+ *
+ */
+declare function capitalize(text: string): string;
+export { capitalize };
+export default capitalize;
+export declare type CapitalizeType = typeof capitalize;
+//# sourceMappingURL=capitalize.d.ts.map

build/utils/index.d.ts

@@ -0,0 +1,15 @@
+import { alphabets } from './alphabet';
+import { capitalize } from './capitalize';
+import { generateRandomString } from './string-random';
+import { lowerCaseLetters } from './alphabet';
+import { shuffleString } from './shuffle-string';
+import { symbols } from './alphabet';
+import { upperCaseLetters } from './alphabet';
+export { alphabets, capitalize, generateRandomString, lowerCaseLetters, upperCaseLetters, shuffleString, symbols, };
+export declare type AlphabetType = typeof alphabets;
+export declare type CapitalizeType = typeof capitalize;
+export declare type LowerCaseLetterType = typeof lowerCaseLetters;
+export declare type UpperCaseLetterType = typeof upperCaseLetters;
+export declare type NumberType = typeof symbols;
+export declare type SymbolType = typeof symbols;
+//# sourceMappingURL=index.d.ts.map

build/utils/shuffle-string.d.ts

@@ -0,0 +1,9 @@
+/**
+ *A function to shuffle a string passed as an argument
+ * @param {string} word
+ * @returns
+ */
+declare function shuffleString(word: string): string;
+export { shuffleString };
+export declare type ShuffleStringType = typeof shuffleString;
+//# sourceMappingURL=shuffle-string.d.ts.map

build/utils/string-random.d.ts

@@ -0,0 +1,10 @@
+/**
+ *A function that generates alphabet characters and symbols on a given length
+ * @param {number} numberOfCharacters
+ * @returns
+ */
+declare function generateRandomString(numberOfCharacters: number): string;
+export { generateRandomString };
+export declare type GenerateRandomStringType = typeof generateRandomString;
+export default generateRandomString;
+//# sourceMappingURL=string-random.d.ts.map

package.json

@@ -1,6 +1,6 @@
 {
   "name": "string-shuffle",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "A JS module for shuffling strings and other helper methods like alhpabet generation",
   "main": "./build/index.js",
   "scripts": {