# @start-software/node-grep

> Node grep style utility

Latest version **1.1.0** (published 2022-02-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install @start-software/node-grep
pnpm add @start-software/node-grep
yarn add @start-software/node-grep
bun add @start-software/node-grep
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-02-25 |
| First published | 2022-02-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Tom Watkins |
| Maintainers | jackbyrne, tom.watkins |

## Links

- npm: https://www.npmjs.com/package/@start-software/node-grep
- Repository: https://github.com/start-software/node-grep
- Homepage: https://github.com/start-software/node-grep#readme
- Issues: https://github.com/start-software/node-grep/issues
- npm.io page: https://npm.io/package/@start-software/node-grep

## Dependencies (2)

- [pdfjs-dist](https://npm.io/package/pdfjs-dist.md) ^2.12.313
- [word-extractor](https://npm.io/package/word-extractor.md) ^1.0.4

## Recent versions

- 1.1.0 (latest) — 2022-02-25
- 1.0.1 — 2022-02-25
- 1.0.0 — 2022-02-25

## README

# node-grep

Grep style file searching

## Installation

```code
npm i @start-software/node-grep
```

## Usage

The following code searches all files in the `test-files` for an array of search values.

```js
const path = require('path');
const { searchInFiles } = require('@start-software/node-grep');

const testSearch = async () => {
    const dir = path.join(__dirname, 'test-files');
    const searchText = 'Tom';
    const result = await searchInFiles(dir, searchText);
    return result;
};

testSearch().then(result => console.log(result));
```

#### Output

```js
['file1.txt', 'file3.txt', 'file5.docx'];
```

## Supported files types

-   All text files
-   PDFs
-   Word documents (.doc and .docx)

---
_Source: https://npm.io/package/@start-software/node-grep · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._