inversify-token

Token-based injection for InversifyJS

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
inversify-token
1256.0.2a year ago4 years agoMinified + gzip package size for inversify-token in KB

Readme

inversify-token
npm CircleCI
Source: https://github.com/mscharley/inversify-token
Author: Matthew Scharley
Contributors: See contributors on GitHubgh-contrib
Bugs/Support: Github Issuesgh-issues
Copyright: 2021
License: MIT licenselicense
Status: Active

Synopsis

This library provides simpler, more type-safe options for injecting values using Inversify.

Installation

$ npm i inversify-token

Usage

Modified from the InversifyJS readme.
// Declare your interfaces as normal.

// file types.ts
import { Token, TokenType } from "inversify-token";
import { Warrior, Weapon, ThrowableWeapon } from "./interfaces";

const WarriorToken = new Token<Warrior>(Symbol.for("Warrior"));
type WarriorToken = TokenType<typeof WarriorToken>;
const WeaponToken = new Token<Weapon>(Symbol.for("Weapon"));
type WeaponToken = TokenType<typeof WeaponToken>;
const ThrowableWeaponToken = new Token<ThrowableWeapon>(
  Symbol.for("ThrowableWeapon")
);
type ThrowableWeaponToken = TokenType<typeof ThrowableWeaponToken>;

export {
  WarriorToken as Warrior,
  WeaponToken as Weapon,
  ThrowableWeaponToken as ThrowableWeapon,
};

// file entities.ts
import { injectable } from "inversify";
import { injectToken } from "inversify-token";
import * as TYPES from "./types";

@injectable()
class Ninja implements Warrior {
  public constructor(
    @injectToken(TYPES.Weapon) private _katana: TYPES.Weapon,
    @injectToken(TYPES.ThrowableWeapon) private _shuriken: TYPES.ThrowableWeapon
  ) {}

  public fight() {
    return this._katana.hit();
  }
  public sneak() {
    return this._shuriken.throw();
  }
}

// file inversify.config.ts
import { getToken, tokenBinder } from "inversify-token";

const myContainer = new Container();
const bindToken = tokenBinder(myContainer.bind.bind(myContainer));
bindToken(TYPES.Warrior).to(Ninja);
bindToken(TYPES.Weapon).to(Katana);
bindToken(TYPES.ThrowableWeapon).to(Shuriken);
const warrior = getToken(container, TYPES.Warrior);

// file inversify.module.ts
import { getToken, TokenContainerModule } from "inversify-token";

const myContainer = new Container();
const module = new TokenContainerModule((bindToken) => {
  bindToken(TYPES.Warrior).to(Ninja);
  bindToken(TYPES.Weapon).to(Katana);
  bindToken(TYPES.ThrowableWeapon).to(Shuriken);
});
myContainer.load(module);
const warrior = getToken(container, TYPES.Warrior);