1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
# repeat-string [![NPM version](https://img.shields.io/npm/v/repeat-string.svg)](https://www.npmjs.com/package/repeat-string) [![Build Status](https://img.shields.io/travis/jonschlinkert/repeat-string.svg)](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._
|