diff options
Diffstat (limited to 'node_modules/repeat-string/README.md')
| -rw-r--r-- | node_modules/repeat-string/README.md | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/node_modules/repeat-string/README.md b/node_modules/repeat-string/README.md new file mode 100644 index 000000000..975c2be6a --- /dev/null +++ b/node_modules/repeat-string/README.md @@ -0,0 +1,118 @@ +# repeat-string [](https://www.npmjs.com/package/repeat-string) [](https://travis-ci.org/jonschlinkert/repeat-string) + +> Repeat the given string n times. Fastest implementation for repeating a string. + +## Install + +Install with [npm](https://www.npmjs.com/): + +```sh +$ npm install repeat-string --save +``` + +## Usage + +### [repeat](index.js#L41) + +Repeat the given `string` the specified `number` of times. + +**Example:** + +**Params** + +* `string` **{String}**: The string to repeat +* `number` **{Number}**: The number of times to repeat the string +* `returns` **{String}**: Repeated string + +**Example** + +```js +var repeat = require('repeat-string'); +repeat('A', 5); +//=> AAAAA +``` + +## Benchmarks + +Repeat string is significantly faster than the native method (which is itself faster than [repeating](https://github.com/sindresorhus/repeating)): + +```sh +#1: 5 + native x 10,484,023 ops/sec ±1.24% (89 runs sampled) + repeat-string x 16,189,255 ops/sec ±1.05% (91 runs sampled) + repeating x 9,051,715 ops/sec ±1.18% (90 runs sampled) + +#2: 50 + native x 7,975,566 ops/sec ±1.29% (91 runs sampled) + repeat-string x 15,317,972 ops/sec ±1.16% (87 runs sampled) + repeating x 6,279,112 ops/sec ±1.29% (89 runs sampled) + +#3: 250 + native x 6,212,752 ops/sec ±1.33% (91 runs sampled) + repeat-string x 14,565,168 ops/sec ±0.83% (93 runs sampled) + repeating x 5,787,124 ops/sec ±1.25% (92 runs sampled) + +#4: 2000 + native x 4,912,163 ops/sec ±1.27% (91 runs sampled) + repeat-string x 17,129,748 ops/sec ±1.01% (91 runs sampled) + repeating x 4,613,043 ops/sec ±1.37% (91 runs sampled) + +#5: 20000 + native x 4,506,624 ops/sec ±1.33% (90 runs sampled) + repeat-string x 14,877,672 ops/sec ±1.00% (93 runs sampled) + repeating x 4,305,756 ops/sec ±1.36% (89 runs sampled) +``` + +**Run the benchmarks** + +Install dev dependencies: + +```sh +npm i -d && node benchmark +``` + +## Related projects + +[repeat-element](https://www.npmjs.com/package/repeat-element): Create an array by repeating the given value n times. | [homepage](https://github.com/jonschlinkert/repeat-element) + +## Contributing + +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/repeat-string/issues/new). + +## Building docs + +Generate readme and API documentation with [verb](https://github.com/verbose/verb): + +```sh +$ npm install verb && npm run docs +``` + +Or, if [verb](https://github.com/verbose/verb) is installed globally: + +```sh +$ verb +``` + +## Running tests + +Install dev dependencies: + +```sh +$ npm install -d && npm test +``` + +## Author + +**Jon Schlinkert** + +* [github/jonschlinkert](https://github.com/jonschlinkert) +* [twitter/jonschlinkert](http://twitter.com/jonschlinkert) + +## License + +Copyright © 2016 [Jon Schlinkert](http://github.com/jonschlinkert) +Released under the [MIT license](https://github.com/jonschlinkert/repeat-string/blob/master/LICENSE). + +*** + +_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on February 29, 2016._
\ No newline at end of file |