# longest-streak

> Count the longest repeating streak of a substring

Latest version **3.1.0** (published 2022-11-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install longest-streak
pnpm add longest-streak
yarn add longest-streak
bun add longest-streak
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.0 |
| Published | 2022-11-15 |
| First published | 2015-07-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Titus Wormer |
| Maintainers | wooorm |
| Keywords | count, length, longest, repeating, streak, substring, character |

## Links

- npm: https://www.npmjs.com/package/longest-streak
- Repository: https://github.com/wooorm/longest-streak
- Homepage: https://github.com/wooorm/longest-streak#readme
- Issues: https://github.com/wooorm/longest-streak/issues
- Funding: https://github.com/sponsors/wooorm
- npm.io page: https://npm.io/package/longest-streak

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 3.1.0 (latest) — 2022-11-15
- 3.0.1 — 2021-10-27
- 3.0.0 — 2021-03-08
- 2.0.4 — 2020-01-25
- 2.0.3 — 2019-05-13
- 2.0.2 — 2017-11-08
- 2.0.1 — 2016-11-26
- 2.0.0 — 2016-11-11
- 1.0.0 — 2015-07-12

## README

# longest-streak

[![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`.

## Contents

*   [What is this?](#what-is-this)
*   [When should I use this?](#when-should-i-use-this)
*   [Install](#install)
*   [Use](#use)
*   [API](#api)
    *   [`longestStreak(value, substring)`](#longeststreakvalue-substring)
*   [Types](#types)
*   [Compatibility](#compatibility)
*   [Security](#security)
*   [Related](#related)
*   [Contribute](#contribute)
*   [License](#license)

## What is this?

This is a tiny package that finds the count of the longest adjacent repeating
substring.

## When should I use this?

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.

## Install

This package is [ESM only][esm].
In Node.js (version 14.14+, 16.0+), install with [npm][]:

```sh
npm install longest-streak
```

In Deno with [`esm.sh`][esmsh]:

```js
import {longestStreak} from 'https://esm.sh/longest-streak@3'
```

In browsers with [`esm.sh`][esmsh]:

```html
<script type="module">
  import {longestStreak} from 'https://esm.sh/longest-streak@3?bundle'
</script>
```

## Use

```js
import {longestStreak} from 'longest-streak'

longestStreak('` foo `` bar `', '`') // => 2
```

## API

This package exports the identifier `longestStreak`.
There is no default export.

### `longestStreak(value, substring)`

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 `substring`s in `value` (`number`).

## Types

This package is fully typed with [TypeScript][].
It exports no additional types.

## Compatibility

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.

## Security

This package is safe.

## Related

*   [`wooorm/ccount`](https://github.com/wooorm/ccount)
    — count the total number of `substring`s in `value`
*   [`wooorm/direction`](https://github.com/wooorm/direction)
    — detect directionality: left-to-right, right-to-left, or neutral

## Contribute

Yes please!
See [How to Contribute to Open Source][contribute].

## License

[MIT][license] © [Titus Wormer][author]

<!-- Definitions -->

[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

---
_Source: https://npm.io/package/longest-streak · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._