repeat-string

What is repeat-string?

The repeat-string npm package is a minimalistic library that allows users to repeat a given string a specified number of times. It is useful for creating padding, indentation, or repeating patterns in strings.

What are repeat-string's main functionalities?

String repetition

Repeats the '*' character 3 times to produce the string '***'.

"*".repeat(3)

Other packages similar to repeat-string

string.prototype.repeat

This package is a polyfill for the String.prototype.repeat method as per the ECMAScript 6 (ES2015) specification. It provides the same functionality as repeat-string but also ensures compatibility with older environments that do not support the native .repeat() method.

pad

The pad package offers string padding functionalities. While repeat-string focuses solely on repeating strings, pad allows you to add characters to the start or end of a string to reach a desired length, which can include repeating a character or string.

repeat-element

Repeat-element is similar to repeat-string but is designed to repeat any given element, not just strings. It can be used to create an array with repeated elements, which can then be joined into a string if needed.

README

repeat-string

Repeat the given string n times. Fastest implementation for repeating a string.

Install

Install with npm:

$ npm install repeat-string --save

Usage

repeat

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

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):

#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:

npm i -d && node benchmark

Related projects

repeat-element: Create an array by repeating the given value n times. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

This file was generated by verb, v0.9.0, on February 29, 2016.