0.1.1 ā€¢ Published 1 year ago

dinjectease v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Dinjectease

šŸ“¦ Tiny DI container to control dependency injection with ease.

The project has been inspired heavily by Pimple.

codecov GitHub commit checks state

Getting started

Installation

Install dinjectease from npm:

npm install dinjectease

Usage

To create a container, initialize the Container class:

import Container from 'dinjectease';

const container = new Container();

Dinjectease supports different types of values: services (initialized once on first fetch), factories (initialized on each fetch) and raw values (returned as defined).

Defining raw values

Raw values are a great way to define the configuration values to be usable from the container. You can store any value, starting from configuration strings, through objects and arrays to callables or whole class instances.

Raw values are saved as provided.

container.raw('app_name', 'Dinjectease');
container.raw('default_lang', 'en');

Defining services

Services are defined using a callback:

type Definition<T = any> = (c: Container) => T;

When a service is fetched from the container, always the same instance is returned. If the instance doesn't exist, it is created by calling the provided callback.

The definition takes current container instance as the only argument.

container.raw('mailer_transport', 'gmail');
container.set('mailer', (c) => new MailerService(c.get('mailer_transport')));

Now every call to container.get('mailer') returns same instance of the MailerService.

Defining factories

By default, all services are created only once. If you want to have an instance created every time the service is fetched, use the factory method instead of set.

container.factory('mailer', (c) => new MailerService(c.get('mailer_transport')));

Now every call to container.get('mailer') returns a new instance of the MailerService.

šŸ¤ Contributing

Contributions, issues and feature requests are welcome! Feel free to check issues page.

Show your support

Give a ā­ļø if this project helped you!

šŸ“ License

Copyright Ā© 2023 Piotr Rzeczkowski. This project is MIT licensed.