1# repeat-string [![NPM version](https://img.shields.io/npm/v/repeat-string.svg?style=flat)](https://www.npmjs.com/package/repeat-string) [![NPM monthly downloads](https://img.shields.io/npm/dm/repeat-string.svg?style=flat)](https://npmjs.org/package/repeat-string)  [![NPM total downloads](https://img.shields.io/npm/dt/repeat-string.svg?style=flat)](https://npmjs.org/package/repeat-string) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/repeat-string.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/repeat-string)
2
3> Repeat the given string n times. Fastest implementation for repeating a string.
4
5## Install
6
7Install with [npm](https://www.npmjs.com/):
8
9```sh
10$ npm install --save repeat-string
11```
12
13## Usage
14
15### [repeat](index.js#L41)
16
17Repeat the given `string` the specified `number` of times.
18
19**Example:**
20
21**Example**
22
23```js
24var repeat = require('repeat-string');
25repeat('A', 5);
26//=> AAAAA
27```
28
29**Params**
30
31* `string` **{String}**: The string to repeat
32* `number` **{Number}**: The number of times to repeat the string
33* `returns` **{String}**: Repeated string
34
35## Benchmarks
36
37Repeat string is significantly faster than the native method (which is itself faster than [repeating](https://github.com/sindresorhus/repeating)):
38
39```sh
40# 2x
41repeat-string  █████████████████████████  (26,953,977 ops/sec)
42repeating      █████████                  (9,855,695 ops/sec)
43native         ██████████████████         (19,453,895 ops/sec)
44
45# 3x
46repeat-string  █████████████████████████  (19,445,252 ops/sec)
47repeating      ███████████                (8,661,565 ops/sec)
48native         ████████████████████       (16,020,598 ops/sec)
49
50# 10x
51repeat-string  █████████████████████████  (23,792,521 ops/sec)
52repeating      █████████                  (8,571,332 ops/sec)
53native         ███████████████            (14,582,955 ops/sec)
54
55# 50x
56repeat-string  █████████████████████████  (23,640,179 ops/sec)
57repeating      █████                      (5,505,509 ops/sec)
58native         ██████████                 (10,085,557 ops/sec)
59
60# 250x
61repeat-string  █████████████████████████  (23,489,618 ops/sec)
62repeating      ████                       (3,962,937 ops/sec)
63native         ████████                   (7,724,892 ops/sec)
64
65# 2000x
66repeat-string  █████████████████████████  (20,315,172 ops/sec)
67repeating      ████                       (3,297,079 ops/sec)
68native         ███████                    (6,203,331 ops/sec)
69
70# 20000x
71repeat-string  █████████████████████████  (23,382,915 ops/sec)
72repeating      ███                        (2,980,058 ops/sec)
73native         █████                      (5,578,808 ops/sec)
74```
75
76**Run the benchmarks**
77
78Install dev dependencies:
79
80```sh
81npm i -d && node benchmark
82```
83
84## About
85
86### Related projects
87
88[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 "Create an array by repeating the given value n times.")
89
90### Contributing
91
92Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
93
94### Contributors
95
96| **Commits** | **Contributor**<br/> |
97| --- | --- |
98| 51 | [jonschlinkert](https://github.com/jonschlinkert) |
99| 2 | [LinusU](https://github.com/LinusU) |
100| 2 | [tbusser](https://github.com/tbusser) |
101| 1 | [doowb](https://github.com/doowb) |
102| 1 | [wooorm](https://github.com/wooorm) |
103
104### Building docs
105
106_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
107
108To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
109
110```sh
111$ npm install -g verb verb-generate-readme && verb
112```
113
114### Running tests
115
116Install dev dependencies:
117
118```sh
119$ npm install -d && npm test
120```
121
122### Author
123
124**Jon Schlinkert**
125
126* [github/jonschlinkert](https://github.com/jonschlinkert)
127* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
128
129### License
130
131Copyright © 2016, [Jon Schlinkert](http://github.com/jonschlinkert).
132Released under the [MIT license](https://github.com/jonschlinkert/repeat-string/blob/master/LICENSE).
133
134***
135
136_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on October 23, 2016._