Pattern

Loki pattern in JavaScript/TypeScript

🚧 Requirements

- Node.js version 18 or higher

🚀 Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn

``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
- NoopPattern

$3

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