{"id":20872727,"url":"https://github.com/zalari/ngrx-utils","last_synced_at":"2026-04-23T15:31:57.247Z","repository":{"id":31875057,"uuid":"130054316","full_name":"zalari/ngrx-utils","owner":"zalari","description":"A library containing tagging decorators for @ngrx to help implementing the Nrwl conventions for @ngrx/effects.","archived":false,"fork":false,"pushed_at":"2022-06-22T17:13:18.000Z","size":231,"stargazers_count":1,"open_issues_count":9,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-27T01:35:46.679Z","etag":null,"topics":["activity-diagram","cli-app","conventions","ngrx","ngrx-effects","ngrx-utils","nrwl","plantuml","tagging-decorators","utils"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zalari.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-18T11:49:54.000Z","updated_at":"2020-09-23T18:19:46.000Z","dependencies_parsed_at":"2022-08-27T13:11:40.097Z","dependency_job_id":null,"html_url":"https://github.com/zalari/ngrx-utils","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/zalari/ngrx-utils","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalari%2Fngrx-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalari%2Fngrx-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalari%2Fngrx-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalari%2Fngrx-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zalari","download_url":"https://codeload.github.com/zalari/ngrx-utils/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalari%2Fngrx-utils/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32186755,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-23T15:28:30.493Z","status":"ssl_error","status_checked_at":"2026-04-23T15:28:29.972Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["activity-diagram","cli-app","conventions","ngrx","ngrx-effects","ngrx-utils","nrwl","plantuml","tagging-decorators","utils"],"created_at":"2024-11-18T06:20:28.227Z","updated_at":"2026-04-23T15:31:57.215Z","avatar_url":"https://github.com/zalari.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/zalari/ngrx-utils.svg?branch=master)](https://travis-ci.org/zalari/ngrx-utils)\n[![GitHub version](https://badge.fury.io/gh/zalari%2Fngrx-utils.svg)](https://badge.fury.io/gh/zalari%2Fngrx-utils)\n[![npm version](https://badge.fury.io/js/%40zalari%2Fngrx-utils.svg)](https://badge.fury.io/js/%40zalari%2Fngrx-utils)\n# Ngrx utils\nA library containing tagging decorators for [@ngrx] to help implementing the\n[Nrwl conventions][nrwl.io] for [@ngrx/effects].\n\n## Getting started\nJust install the package from npm.\n```:bash\nnpm i --save-dev @zalari/ngrx-utils\n```\n\n## Runtime evaluation\nThis package includes tagging decorators and classes for runtime evaluation.\n\n### [Action classes][Categories of Actions]\n* [CommandAction][Command]\n* [DocumentAction][Document]\n* [EventAction][Event]\n\nUsage example:\n```:typescript\n// command types as string based enums\nexport enum ExampleCommandTypes {\n    Foo = '[Example] Foo'\n}\n\n// commands\nexport class FooCommand implements CommandAction {\n    readonly type = ExampleCommandTypes.Foo;\n}\n```\n\n### Tagging decorators for [Actions][@ngrx/actions]\nThe effects are distinguished into two groups, [Deciders] and [Transformers].\n\n#### Action [Deciders]\n* [AggregatorDecider]\n* [ContentBasedDecider]\n* [ContextBasedDecider]\n* [FilteringDecider]\n* [SplitterDecider]\n\n#### Action [Transformers]\n* [EnrichTransformer]\n* [NormalizeTransformer]\n\n## CLI tool\nAdditionally a command line tool is included to generate [activity diagrams][Activity diagram]\nin the [PlantUML] file format from given effect files.\n\n### Run\nThe cli tool can be run using `ngrx-utils`.\n\nIf this somehow won't work, you can use `node_modules/.bin/ngrx-utils` on Linux or Mac, or \n`node_modules/.bin/ngrx-utils.cmd` on Windows.\n\n### Options\nThe options can be shown by running `ngrx-utils --help`:\n```:bash\n    -V, --version                      output the version number\n    -c, --config \u003cpath\u003e                path to tsconfig.json\n    -s, --source \u003cpath\u003e                path to ngrx effects source file\n    -d, --diagram \u003cactivity|sequence\u003e  the diagram type to use (default: activity)\n    -h, --help                         output usage information\n```\n\n### Example using the test data\n* A simple test case is: `ngrx-utils --config test/test.tsconfig.json --source test/test.effects.ts`.\n* Globbing source files: `ngrx-utils --config test/test.tsconfig.json --source **/*.effects.ts`.\n* Extended tsconfig.json: `ngrx-utils --config test/test-extending.tsconfig.json --source **/*.effects.ts`.\n\n\u003e By default the [Angular CLI][@angular/angular-cli] creates a base `tsconfig.json` in the root directory which is extended by specific\nconfig files in the `src` folder (e.g. `tsconfig.app.json`) by using the `extends` property. The CLI tool recognizes this property and\nloads all extended configs recursively and merges the `compilerOptions`.\n\n### Run tests\nThe tests are based on [Mocha] and [Chai].\n\n`npm run test`\n\n[@ngrx]: https://github.com/ngrx/platform\n[@ngrx/effects]: https://github.com/ngrx/platform/tree/master/docs/effects\n[@ngrx/actions]: https://github.com/ngrx/platform/blob/master/docs/store/actions.md#typed-actions\n\n[@angular/angular-cli]: https://github.com/angular/angular-cli\n\n[nrwl.io]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5\n[Categories of Actions]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#8d68\n[Command]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#219c\n[Document]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#3385\n[Event]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#68eb\n\n[Deciders]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#ae62\n[AggregatorDecider]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#6e15\n[ContentBasedDecider]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#ab44\n[ContextBasedDecider]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#19ad\n[FilteringDecider]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#d712\n[SplitterDecider]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#cdd3\n\n[Transformers]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#ada3\n[EnrichTransformer]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#4da0\n[NormalizeTransformer]: https://blog.nrwl.io/ngrx-patterns-and-techniques-f46126e2b1e5#5ee1\n\n[PlantUML]: http://plantuml.com/\n[Activity diagram]: http://plantuml.com/activity-diagram-beta\n[Mocha]: https://mochajs.org/\n[Chai]: http://www.chaijs.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzalari%2Fngrx-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzalari%2Fngrx-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzalari%2Fngrx-utils/lists"}