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 --save repeat-string

Usage

repeat

Repeat the given string the specified number of times.

Example:

Example

var repeat = require('repeat-string');
repeat('A', 5);
//=> AAAAA

Params

• string {String}: The string to repeat
• number {Number}: The number of times to repeat the string
• returns {String}: Repeated string

Benchmarks

Repeat string is significantly faster than the native method (which is itself faster than repeating):

# 2x
repeat-string  █████████████████████████  (26,953,977 ops/sec)
repeating      █████████                  (9,855,695 ops/sec)
native         ██████████████████         (19,453,895 ops/sec)

# 3x
repeat-string  █████████████████████████  (19,445,252 ops/sec)
repeating      ███████████                (8,661,565 ops/sec)
native         ████████████████████       (16,020,598 ops/sec)

# 10x
repeat-string  █████████████████████████  (23,792,521 ops/sec)
repeating      █████████                  (8,571,332 ops/sec)
native         ███████████████            (14,582,955 ops/sec)

# 50x
repeat-string  █████████████████████████  (23,640,179 ops/sec)
repeating      █████                      (5,505,509 ops/sec)
native         ██████████                 (10,085,557 ops/sec)

# 250x
repeat-string  █████████████████████████  (23,489,618 ops/sec)
repeating      ████                       (3,962,937 ops/sec)
native         ████████                   (7,724,892 ops/sec)

# 2000x
repeat-string  █████████████████████████  (20,315,172 ops/sec)
repeating      ████                       (3,297,079 ops/sec)
native         ███████                    (6,203,331 ops/sec)

# 20000x
repeat-string  █████████████████████████  (23,382,915 ops/sec)
repeating      ███                        (2,980,058 ops/sec)
native         █████                      (5,578,808 ops/sec)

Run the benchmarks

Install dev dependencies:

npm i -d && node benchmark

About

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.

Contributors

Commits	Contributor
51	jonschlinkert
2	LinusU
2	tbusser
1	doowb
1	wooorm

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && 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-generate-readme, v0.2.0, on October 23, 2016.