@chojs/core

Core modules for the CHO framework.

The CHO core module provides the fundamental building blocks for the CHO framework, including dependency injection, metadata handling, and application lifecycle management.

Public API

Dependency injection and application lifecycle management decorators (@Injectable, @Module, @Controller, etc.) @Injectable.

Submodules

Examples

Metadata Utilities

import {addToMetadataObject, readMetadataObject} from "@chojs/core/meta";

Read and write metadata to and from classes and methods. Used by decorators to store metadata in a structured way.

class Example {
}

addToMetadataObject(Example, {key0: "value0"});
addToMetadataObject(Example, {key1: "value1"});

readMetadataObject(Example); // { key0: 'value0', key1: 'value1' }

Arrays with the same key are merged automatically:

class Example {
}

addToMetadataObject(Example, {key: ["value0"]});
addToMetadataObject(Example, {key: ["value1"]});

readMetadataObject(Example); // { key: ['value0', 'value1'] }

Dependency Injection

Create injectable services and organize them into modules:

@Injectable({deps: [DatabaseService]})
class UserService {
    constructor(private db: DatabaseService) {
    }
}

@Module({
    imports: [DatabaseModule],
    providers: [
        {
            provide: UserService,
            factory: (injector) => {
                const db = injector.resolve(DatabaseService);
                return new UserService(db);
            },
        },
    ],
})
class UserModule {
}

Resolving dependencies:

// creating (or getting) injector for specific module
const injector = await Injector.get(UserModule);

// resolving a dependency
const service = await injector.resolve(UserService);

Application Lifecycle

Compiling application:

@Module()
class Example {
}

const graph = graphBuilder(Example);
const initiated = await new Compiler().compile(graph);

Applying lifecycle hooks:

onModuleInit(initiated);

Testing

Using single test runner for all environments:

import {test} from "@chojs/core/testing";

test("example test", () => {
    // test code
});

Utilities

Private API utilities