{"id":17085592,"url":"https://github.com/hisorange/kernel","last_synced_at":"2025-04-12T21:37:04.860Z","repository":{"id":60809691,"uuid":"545173357","full_name":"hisorange/kernel","owner":"hisorange","description":"Async Application Kernel written in TypeScript","archived":false,"fork":false,"pushed_at":"2023-12-03T23:40:52.000Z","size":125,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-05T06:51:14.669Z","etag":null,"topics":["application","async","kernel","modules"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hisorange.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-10-03T23:01:48.000Z","updated_at":"2022-11-03T21:12:47.000Z","dependencies_parsed_at":"2023-12-03T16:26:49.538Z","dependency_job_id":"ac6566c5-543a-4435-a0f1-f594c0419fa3","html_url":"https://github.com/hisorange/kernel","commit_stats":{"total_commits":16,"total_committers":1,"mean_commits":16.0,"dds":0.0,"last_synced_commit":"db40355d1d415f16704ab052b5e3397dad5e2b11"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hisorange%2Fkernel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hisorange%2Fkernel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hisorange%2Fkernel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hisorange%2Fkernel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hisorange","download_url":"https://codeload.github.com/hisorange/kernel/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239979036,"owners_count":19728452,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["application","async","kernel","modules"],"created_at":"2024-10-14T13:25:19.255Z","updated_at":"2025-02-22T05:31:14.595Z","avatar_url":"https://github.com/hisorange.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Async Application Kernel\n\n[![Version](https://img.shields.io/npm/v/@hisorange/kernel?label=Version)](https://www.npmjs.com/package/@hisorange/kernel)\n[![Build](https://github.com/hisorange/kernel/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/hisorange/kernel/actions/workflows/ci.yml)\n[![NPM](https://img.shields.io/npm/dt/@hisorange/kernel?label=NPM)](https://www.npmjs.com/package/@hisorange/kernel)\n[![GitHub Last Update](https://img.shields.io/github/last-commit/hisorange/kernel?label=Last%20Updated)](https://github.com/hisorange/kernel/commits/main)\n[![License](https://img.shields.io/github/license/hisorange/kernel?label=License)](https://github.com/hisorange/kernel/blob/main/license)\n[![Coverage Status](https://coveralls.io/repos/github/hisorange/kernel/badge.svg?branch=main)](https://coveralls.io/github/hisorangekernel?branch=main)\n\nJust my personal take on an async application kernel. It has injection management, simple module system, and a few other things.\n\nNotable features are:\n\n- Dependency injection\n- Module with lifecycle hooks and dependency order\n- Scheduled tasks with CRON and injections\n- Built in event bus and respective decorators\n\n## Getting Started\n\n```sh\nyarn add @hisorange/kernel\n```\n\n## Usage\n\n```ts\nconst kernel = new Kernel();\nkernel.register([MyModule, SecondModule]);\n\nawait kernel.boostrap();\nawait kernel.start();\n\nprocess.on(\n  'SIGINT',\n  kernel.stop().then(() =\u003e process.exit(0)),\n);\n```\n\n## Module\n\n```ts\n@Module({\n  providers: [],\n  imports: [ConfigModule],\n  dependsOn: [DatabaseModule],\n})\nexport class MyModule implements IModule {\n  public async onBoot() {\n    // Executed in dependency order, you can setup your module here.\n    // And the dependencies are already booted.\n  }\n\n  public async onStart() {\n    // Runs after every module is booted.\n    // Can do any async tasks here.\n  }\n\n  public async onStop() {\n    // Called when a stop signal is received.\n  }\n}\n```\n\n## Scheduler\n\n```ts\n@Scheduler()\nexport class MyScheduler {\n  constructor(private readonly myService: MyService) {}\n\n  @Job({\n    name: 'my-named-job',\n    timings: '*/5 * * * * *',\n  })\n  public async myJob() {\n    this.myService.doSomething();\n  }\n}\n```\n\n## Event Handler\n\n```ts\n@Observer()\nexport class MyObserver {\n  constructor(private readonly myService: MyService) {}\n\n  @On('sql.query', {\n    debounce: 1_000,\n  })\n  public async onSqlQUery() {\n    this.myService.doSomething();\n  }\n}\n```\n\nOnce I gotta write a proper readme, but for now, this is it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhisorange%2Fkernel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhisorange%2Fkernel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhisorange%2Fkernel/lists"}