diff --git a/dist/index.d.ts b/dist/index.d.ts index ba44b4e..ba66bc0 100644 --- a/dist/index.d.ts +++ b/dist/index.d.ts @@ -1,4 +1,12 @@ import "./String"; +/** + * Returns a random string for the provided length and range. + * + * @param length of returned string in [0..8] + * @param range of characters in [2..36] + * + * @returns a random string + */ export declare function random(length?: number, range?: number): string; export default random; //# sourceMappingURL=index.d.ts.map \ No newline at end of file diff --git a/dist/index.d.ts.map b/dist/index.d.ts.map index 6b4194a..3ff0065 100644 --- a/dist/index.d.ts.map +++ b/dist/index.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,CAAC;AAElB,+BAAuB,MAAM,GAAE,MAAU,EAAE,KAAK,GAAE,MAAW,GAAG,MAAM,CAErE;AAED,eAAe,MAAM,CAAC"} \ No newline at end of file +{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,CAAC;AAElB;;;;;;;GAOG;AACH,+BAAuB,MAAM,GAAE,MAAU,EAAE,KAAK,GAAE,MAAW,GAAG,MAAM,CAErE;AAED,eAAe,MAAM,CAAC"} \ No newline at end of file diff --git a/dist/index.js b/dist/index.js index d8eaa73..9fc9bd1 100644 --- a/dist/index.js +++ b/dist/index.js @@ -2,11 +2,19 @@ Object.defineProperty(exports, "__esModule", { value: true }); require("./String"); +/** + * Returns a random string for the provided length and range. + * + * @param length of returned string in [0..8] + * @param range of characters in [2..36] + * + * @returns a random string + */ function random() { - var length = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0; - var range = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 36; + var length = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0; + var range = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 36; - return String.random(length, range); + return String.random(length, range); } exports.random = random; exports.default = random; diff --git a/dist/index.js.map b/dist/index.js.map index cb5a164..1937a37 100644 --- a/dist/index.js.map +++ b/dist/index.js.map @@ -1 +1 @@ -{"version":3,"sources":["index.js"],"names":["Object","defineProperty","exports","value","require","random","length","range","String","default"],"mappings":"AAAA;;AACAA,OAAOC,cAAP,CAAsBC,OAAtB,EAA+B,YAA/B,EAA6C,EAAEC,OAAO,IAAT,EAA7C;AACAC,QAAQ,UAAR;AACA,SAASC,MAAT,GAAwC;AAAA,QAAxBC,MAAwB,uEAAf,CAAe;AAAA,QAAZC,KAAY,uEAAJ,EAAI;;AACpC,WAAOC,OAAOH,MAAP,CAAcC,MAAd,EAAsBC,KAAtB,CAAP;AACH;AACDL,QAAQG,MAAR,GAAiBA,MAAjB;AACAH,QAAQO,OAAR,GAAkBJ,MAAlB","file":"index.js","sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nrequire(\"./String\");\nfunction random(length = 0, range = 36) {\n return String.random(length, range);\n}\nexports.random = random;\nexports.default = random;\n"]} \ No newline at end of file +{"version":3,"sources":["index.js"],"names":["Object","defineProperty","exports","value","require","random","length","range","String","default"],"mappings":"AAAA;;AACAA,OAAOC,cAAP,CAAsBC,OAAtB,EAA+B,YAA/B,EAA6C,EAAEC,OAAO,IAAT,EAA7C;AACAC,QAAQ,UAAR;AACA;;;;;;;;AAQA,SAASC,MAAT,GAAwC;AAAA,MAAxBC,MAAwB,uEAAf,CAAe;AAAA,MAAZC,KAAY,uEAAJ,EAAI;;AACpC,SAAOC,OAAOH,MAAP,CAAcC,MAAd,EAAsBC,KAAtB,CAAP;AACH;AACDL,QAAQG,MAAR,GAAiBA,MAAjB;AACAH,QAAQO,OAAR,GAAkBJ,MAAlB","file":"index.js","sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nrequire(\"./String\");\n/**\n * Returns a random string for the provided length and range.\n *\n * @param length of returned string in [0..8]\n * @param range of characters in [2..36]\n *\n * @returns a random string\n */\nfunction random(length = 0, range = 36) {\n return String.random(length, range);\n}\nexports.random = random;\nexports.default = random;\n"]} \ No newline at end of file diff --git a/lib/index.ts b/lib/index.ts index b37c16f..c5d4579 100644 --- a/lib/index.ts +++ b/lib/index.ts @@ -1,5 +1,13 @@ import "./String"; +/** + * Returns a random string for the provided length and range. + * + * @param length of returned string in [0..8] + * @param range of characters in [2..36] + * + * @returns a random string + */ export function random(length: number = 0, range: number = 36): string { return String.random(length, range); } diff --git a/test/test.js b/test/test.js index 0ad1e3d..0e43f15 100644 --- a/test/test.js +++ b/test/test.js @@ -25,9 +25,11 @@ describe('index.random', () => { describe('index.random', () => { it('should return a string', () => { expect(index.random()).to.be.a('string'); + expect(String.random()).to.be.a('string'); }); it('should return a default empty string', () => { expect(index.random()).to.equal(''); + expect(String.random()).to.equal(''); }); });