|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172 |
- # longest-streak
-
- [![Build][build-badge]][build]
- [![Coverage][coverage-badge]][coverage]
- [![Downloads][downloads-badge]][downloads]
- [![Size][size-badge]][size]
-
- Count the longest repeating streak of a character.
-
- ## Install
-
- [npm][]:
-
- ```sh
- npm install longest-streak
- ```
-
- ## Use
-
- ```js
- var longestStreak = require('longest-streak')
-
- 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][author]
-
- <!-- Definitions -->
-
- [build-badge]: https://img.shields.io/travis/wooorm/longest-streak.svg
-
- [build]: https://travis-ci.org/wooorm/longest-streak
-
- [coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/longest-streak.svg
-
- [coverage]: https://codecov.io/github/wooorm/longest-streak
-
- [downloads-badge]: https://img.shields.io/npm/dm/longest-streak.svg
-
- [downloads]: https://www.npmjs.com/package/longest-streak
-
- [size-badge]: https://img.shields.io/bundlephobia/minzip/longest-streak.svg
-
- [size]: https://bundlephobia.com/result?p=longest-streak
-
- [npm]: https://docs.npmjs.com/cli/install
-
- [license]: license
-
- [author]: https://wooorm.com
|