npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

madig

v0.2.2

Published

Javascript dependency injection engine

Downloads

6

Readme

Madig

NPM version Build job

Madig is a Javascript dependency injection engine.

Installation

npm add madig

Usage

Create configuration

Injectable configuration object needs to respect the following format :

[{
  class: ClassFile, // the class to instanciate
  dependsOn: [Dep1ClassFile, Dep2ClassFile] // the classes to inject in the constructor
}]

Module injection

In addition to classes, it is possible to inject modules into the class constructor. To do this, declare the dependency as follows.

[{
  class: ClassFile, // the class to instanciate
  dependsOn: [{name: 'MyModule', MyModule}] // the module to inject in the constructor
}]

Example :

const Madig = require('madig');

// Create new injectable configuration
const madig = new Madig([
  {
    class: TodoController,
    dependsOn: [TodoService],
  },
  {
    class: TodoService,
    dependsOn: [TodoRepository, { name: 'ModuleHelloBis', ModuleHelloBis }],
  },
  {
    class: TodoRepository,
    dependsOn: [Db, { name: 'ModuleHello', ModuleHello }],
  },
]);

Load configuration injection

madig.load method will instanciate all classes declared in the configuration object and inject them.

// Load injection
madig.load();

How does it works

The loading function determines the classes order of instantiation to be able to instantiate them with constructor dependencies.

For example, the previous configuration

[
  {
    class: TodoController,
    dependsOn: [TodoService],
  },
  {
    class: TodoService,
    dependsOn: [TodoRepository, { name: 'ModuleHelloBis', ModuleHelloBis }],
  },
  {
    class: TodoRepository,
    dependsOn: [Db, { name: 'ModuleHello', ModuleHello }],
  },
]

Will be injected in the following order :

  • ModuleHelloBis
  • Db
  • ModuleHello
  • TodoRepository
  • TodoService
  • TodoController

Access to the IOC container

The IOC container is not necessary in a classic usage because all dependencies are automaticly injected.

If you still need access to the container, you can do it like this : madig.container.get('ClassName');

Example :

madig.container.get('TodoController'); // returns TodoController instance

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT