# streamsearch-ts

> Typescript fork of mscdex/streamsearch without Buffer dependency

Latest version **1.0.2** (published 2023-08-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install streamsearch-ts
pnpm add streamsearch-ts
yarn add streamsearch-ts
bun add streamsearch-ts
```

## 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 | 1.0.2 |
| Published | 2023-08-13 |
| First published | 2023-08-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 0 |
| Unpacked size | 15 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | miunau |

## Links

- npm: https://www.npmjs.com/package/streamsearch-ts
- Repository: https://github.com/auth70/streamsearch-ts
- Issues: https://github.com/auth70/streamsearch-ts/issues
- npm.io page: https://npm.io/package/streamsearch-ts

## Recent versions

- 1.0.2 (latest) — 2023-08-13
- 1.0.1 — 2023-08-13
- 1.0.0 — 2023-08-13

## README

# streamsearch-ts

streamsearch-ts allows searching a stream using the Boyer-Moore-Horspool algorithm. It is a Typescript port of [streamsearch by mscdex](https://github.com/mscdex/streamsearch), which in turn is based on [Hongli Lai's C++ version](https://github.com/FooBarWidget/boyer-moore-horspool).

This version does not depend on the Buffer object, hence it can be used in non-node.js environments. It passes the same tests as the original streamsearch module.

## Installation

```sh
npm install streamsearch-ts
```

## Example

See also the tests in `test/`.

```ts
  import { inspect } from 'util';
  import { StreamSearch } from 'streamsearch-ts';

  const needle = '\r\n';
  const ss = new StreamSearch(needle, (isMatch, data, start, end) => {
    if (data)
      console.log('data: ' + inspect(data.toString('latin1', start, end)));
    if (isMatch)
      console.log('match!');
  });

  const haystack = [
    'foo',
    ' bar',
    '\r',
    '\n',
    'baz, hello\r',
    '\n world.',
    '\r\n Node.JS rules!!\r\n\r\n',
  ];

  for (const hay of haystack) ss.push(hay);

  // output:
  //
  // data: 'foo'
  // data: ' bar'
  // match!
  // data: 'baz, hello'
  // match!
  // data: ' world.'
  // match!
  // data: ' Node.JS rules!!'
  // match!
  // data: ''
  // match!
```

## API

### Properties

* **maxMatches** - < _integer_ > - The maximum number of matches. Defaults to `Infinity`.
* **matches** - < _integer_ > - The current match count.

### Functions

* **(constructor)**(< _mixed_ >needle, < _function_ >callback) - Creates and returns a new instance for searching for a _Buffer_ or _string_ `needle`. `callback` is called any time there is non-matching data and/or there is a needle match. `callback` will be called with the following arguments:

  1. `isMatch` - _boolean_ - Indicates whether a match has been found

  2. `data` - _mixed_ - If set, this contains data that did not match the needle.

  3. `start` - _integer_ - The index in `data` where the non-matching data begins (inclusive).

  4. `end` - _integer_ - The index in `data` where the non-matching data ends (exclusive).

  5. `isSafeData` - _boolean_ - Indicates if it is safe to store a reference to `data` (e.g. as-is or via `data.slice()`) or not, as in some cases `data` may point to a Buffer whose contents change over time.

* **destroy**() - _(void)_ - Emits any last remaining unmatched data that may still be buffered and then resets internal state.

* **push**(< _Buffer_ >chunk) - _integer_ - Processes `chunk`, searching for a match. The return value is the last processed index in `chunk` + 1.

* **reset**() - _(void)_ - Resets internal state. Useful for when you wish to start searching a new/different stream for example.

## License

MIT

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