\n\n## 🚧 Requirements\n\n- [Node.js](https://nodejs.org/en/) version 18 or higher\n\n## 🚀 Getting Started\n\nThis 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)\n\n```bash\n$ npm i @sigyn/pattern\n# or\n$ yarn add @sigyn/pattern\n```\n\n## 📚 Usage\n\n```ts\nimport { Pattern } from \"@sigyn/pattern\";\n\nconst parser = new Pattern(\"HTTP <_> \");\n\nconst parsedLogs = parser.executeOnLogs([\n \"HTTP POST 200 /api/v1/dowork\",\n \"HTTP GET 200 /api/v1/dowork\"\n]);\n\n// Automatically infer types \nfor (const { verb, endpoint } of parsedLogs) {\n console.log(verb, endpoint);\n}\n```\n\nYou can also provide an Array to Pattern constructor (quite helpful with long or multipart patterns).\n\n```ts\nnew Pattern([\n \"[schema: |type: ]\",\n \"HTTP <_> \"\n] as const)\n```\n\n> [!TIP]\n> Use `as const` to benefit from type inference\n\n## 🌐 API\n\n- [Pattern](./docs/Pattern.md)\n- [NoopPattern](./docs/NoopPattern.md)\n\n### Shape\n\nPattern and NoopPattern both implement the same Shape using `PatternShape` interface.\n\n```ts\ntype LokiPatternType = string | Array | ReadonlyArray;\n\ninterface PatternShape {\n compile(): (log: string) => [] | [log: LokiLiteralPattern];\n executeOnLogs(logs: Array): LokiLiteralPattern[];\n}\n```\n\n## License\nMIT\n","readmeFilename":"README.md"}
![\"npm](\"https://img.shields.io/github/package-json/v/MyUnisoft/sigyn/main/src/pattern?style=for-the-badge&label=version\")
\n \n \n ![\"size\"](\"https://img.shields.io/bundlephobia/min/@sigyn/pattern?style=for-the-badge\")
\n \n ![](\"https://img.shields.io/github/actions/workflow/status/MyUnisoft/sigyn/pattern.yml?style=for-the-badge\")
\n \n \n ![\"license\"](\"https://img.shields.io/github/license/MyUnisoft/sigyn?style=for-the-badge\")
\n \n