Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hisorange/kernel
Async Application Kernel written in TypeScript
https://github.com/hisorange/kernel
application async kernel modules
Last synced: 3 months ago
JSON representation
Async Application Kernel written in TypeScript
- Host: GitHub
- URL: https://github.com/hisorange/kernel
- Owner: hisorange
- License: gpl-3.0
- Created: 2022-10-03T23:01:48.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-03T23:40:52.000Z (about 1 year ago)
- Last Synced: 2024-10-10T22:51:32.208Z (3 months ago)
- Topics: application, async, kernel, modules
- Language: TypeScript
- Homepage:
- Size: 122 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# Async Application Kernel
[](https://www.npmjs.com/package/@hisorange/kernel)
[](https://github.com/hisorange/kernel/actions/workflows/ci.yml)
[](https://www.npmjs.com/package/@hisorange/kernel)
[](https://github.com/hisorange/kernel/commits/main)
[](https://github.com/hisorange/kernel/blob/main/license)
[](https://coveralls.io/github/hisorangekernel?branch=main)
Just my personal take on an async application kernel. It has injection management, simple module system, and a few other things.
Notable features are:
- Dependency injection
- Module with lifecycle hooks and dependency order
- Scheduled tasks with CRON and injections
- Built in event bus and respective decorators
## Getting Started
```sh
yarn add @hisorange/kernel
```
## Usage
```ts
const kernel = new Kernel();
kernel.register([MyModule, SecondModule]);
await kernel.boostrap();
await kernel.start();
process.on(
'SIGINT',
kernel.stop().then(() => process.exit(0)),
);
```
## Module
```ts
@Module({
providers: [],
imports: [ConfigModule],
dependsOn: [DatabaseModule],
})
export class MyModule implements IModule {
public async onBoot() {
// Executed in dependency order, you can setup your module here.
// And the dependencies are already booted.
}
public async onStart() {
// Runs after every module is booted.
// Can do any async tasks here.
}
public async onStop() {
// Called when a stop signal is received.
}
}
```
## Scheduler
```ts
@Scheduler()
export class MyScheduler {
constructor(private readonly myService: MyService) {}
@Job({
name: 'my-named-job',
timings: '*/5 * * * * *',
})
public async myJob() {
this.myService.doSomething();
}
}
```
## Event Handler
```ts
@Observer()
export class MyObserver {
constructor(private readonly myService: MyService) {}
@On('sql.query', {
debounce: 1_000,
})
public async onSqlQUery() {
this.myService.doSomething();
}
}
```
Once I gotta write a proper readme, but for now, this is it.