[![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Size][size-badge]][size]
Get the count of the longest repeating streak of substring in value.
* What is this?
* When should I use this?
* Install
* Use
* API
* longestStreak(value, substring)
* Types
* Compatibility
* Security
* Related
* Contribute
* License
This is a tiny package that finds the count of the longest adjacent repeating substring.
This package is rather niche. I use it for serializing markdown ASTs (particularly fenced code and math).
You can use [ccount][ccount] if you need the total count of substrings
occuring in a value.
This package is [ESM only][esm]. In Node.js (version 14.14+, 16.0+), install with [npm][]:
npm install longest-streak
In Deno with [esm.sh][esmsh]:
import {longestStreak} from 'https://esm.sh/longest-streak@3'
In browsers with [esm.sh][esmsh]:
import {longestStreak} from 'longest-streak'longestStreak(' foo bar ', '') // => 2
This package exports the identifier longestStreak.
There is no default export.
Get the count of the longest repeating streak of substring in value.
###### Parameters
* value (string) — content to search in
* substring (string) — substring to look for, typically one character
###### Returns
Count of most frequent adjacent substrings in value (number).
This package is fully typed with [TypeScript][]. It exports no additional types.
This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.
This package is safe.
* wooorm/ccount
— count the total number of substrings in value
* wooorm/direction`
— detect directionality: left-to-right, right-to-left, or neutral
Yes please! See [How to Contribute to Open Source][contribute].
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/wooorm/longest-streak/workflows/main/badge.svg
[build]: https://github.com/wooorm/longest-streak/actions
[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
[esmsh]: https://esm.sh
[license]: license
[author]: https://wooorm.com
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[typescript]: https://www.typescriptlang.org
[contribute]: https://opensource.guide/how-to-contribute/
[ccount]: https://github.com/wooorm/ccount