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

@ns3/di

v5.2.0

Published

A powerful and lightweight inversion of control container for TypeScript.

Downloads

493

Readme

@ns3/di

This is a powerful and lightweight (weights around 5 KB) dependency injection container for TypeScript. It is designed to be used on both browser and node.js server.

It was inspired by:

📦 Installation

You can get the latest release and the type definitions using your preferred package manager:

> npm install @ns3/di reflect-metadata
> yarn add @ns3/di reflect-metadata
> pnpm add @ns3/di reflect-metadata

Hint! If you want to use a more type-safe version of reflect-metadata, try @abraham/reflection

Configuration

To use decorators enable compilation options in your tsconfig.json file:

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

And once in your application import reflect-metadata:

import 'reflect-metadata';

// ...

Usage

Please refer to e2e spec for examples of usage.

The most basic usage is:

import 'reflect-metadata';
import { Container, Injectable } from '@ns3/di';

@Injectable()
class DependencyClass {
  name = 'implementation dependency';
}

@Injectable()
class MasterClass {
  name = 'implementation master';

  constructor(public dep: DependencyClass) {}
}

const container = Container.make();
const instance = container.get(MasterClass);

A note about classes and interfaces

Typescript interfaces only exist at development time, to ensure type checking. When compiled, they do not generate runtime code. This ensures good performance, but also means that is not possible to use interfaces as the type of a property being injected. There is no runtime information that could allow any reflection on interface type. Take a look at https://github.com/Microsoft/TypeScript/issues/3628 for more information about this.

So:

import 'reflect-metadata';
import { Container, Injectable } from '@ns3/di';

const container = Container.make();

interface IPersonDAO {
  get(id: string): Person;
}

abstract class PersonDAO implements IPersonDAO {
  get(id: string): Person;
}

class PersonDAOImpl implements IPersonDAO {
  get(id: string): Person {
    // get the person and return it...
  }
}

// NOT SUPPORTED
container.provide({ token: IPersonDAO, useClass: PersonDAOImpl });

// SUPPORTED
container.provide({ token: PersonDAO, useClass: PersonDAOImpl });

Restrictions

  • Circular injections are not supported.
  • You can only inject types that are already defined into your file.