## 🚧 Requirements
- [Node.js](https://nodejs.org/en/) version 18 or higher
## 🚀 Getting Started
This package is available in the Node Package Repository and can be easily installed with [npm](https://doc.npmjs.com/getting-started/what-is-npm) or [yarn](https://yarnpkg.com)
```bash
$ npm i @sigyn/pattern
# or
$ yarn add @sigyn/pattern
```
## 📚 Usage
```ts
import { Pattern } from "@sigyn/pattern";
const parser = new Pattern("HTTP <_> ");
const parsedLogs = parser.executeOnLogs([
"HTTP POST 200 /api/v1/dowork",
"HTTP GET 200 /api/v1/dowork"
]);
// Automatically infer types
for (const { verb, endpoint } of parsedLogs) {
console.log(verb, endpoint);
}
```
You can also provide an Array to Pattern constructor (quite helpful with long or multipart patterns).
```ts
new Pattern([
"[schema: |type: ]",
"HTTP <_> "
] as const)
```
> [!TIP]
> Use `as const` to benefit from type inference
## 🌐 API
- [Pattern](./docs/Pattern.md)
- [NoopPattern](./docs/NoopPattern.md)
### Shape
Pattern and NoopPattern both implement the same Shape using `PatternShape` interface.
```ts
type LokiPatternType = string | Array | ReadonlyArray;
interface PatternShape {
compile(): (log: string) => [] | [log: LokiLiteralPattern];
executeOnLogs(logs: Array): LokiLiteralPattern[];
}
```
## License
MIT
---
_Source: https://npm.io/package/@sigyn/pattern · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
