summaryrefslogtreecommitdiff
path: root/tools/eslint/node_modules/longest-streak/readme.md
blob: 780c53cf7b1eda9c7b89d48fce42604ccbce2fe1 (plain)
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
# longest-streak [![Build Status](https://img.shields.io/travis/wooorm/longest-streak.svg?style=flat)](https://travis-ci.org/wooorm/longest-streak) [![Coverage Status](https://img.shields.io/coveralls/wooorm/longest-streak.svg?style=flat)](https://coveralls.io/r/wooorm/longest-streak?branch=master)

Count the longest repeating streak of a character.

## Installation

[npm](https://docs.npmjs.com/cli/install):

```bash
npm install longest-streak
```

**longest-streak** is also available for [bower](http://bower.io/#install-packages),
[component](https://github.com/componentjs/component), [duo](http://duojs.org/#getting-started),
and for AMD, CommonJS, and globals ([uncompressed](longest-streak.js) and
[compressed](longest-streak.min.js)).

## Usage

Dependencies.

```javascript
var longestStreak = require('longest-streak');
```

Process:

```javascript
longestStreak('` foo `` bar `', '`') // 2
```

## API

### longestStreak(value, character)

Get the count of the longest repeating streak of `character` in `value`.

Parameters:

*   `value` (`string`) — Content, coerced to string.
*   `character` (`string`) — Single character to look for.

Returns: `number` — Number of characters at the place where `character`
occurs in its longest streak in `value`.

Throws:

*   `Error` — when `character` is not a single character string.

## License

[MIT](LICENSE) @ [Titus Wormer](http://wooorm.com)