inversify-basic-example - GitLite

KO | EN

gitlite — search

#python #react #ai #android #deep-learning #docker #macos #java #awesome #cli #kubernetes #pytorch #ios #open-source

inversify-basic-example

(★ 109)

A basic example that showcases how to setup InversifyJS

File Explorer

Download Latest Version (.zip)

- settings.json
- - ioc_config.ts
- - identifiers.ts
  - tags.ts
- - index.ts
- - battle.ts
  - index.ts
  - warrior.ts
  - weapon.ts
- main.ts
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
gulpfile.js
ISSUE_TEMPLATE.md
LICENSE
package.json
PULL_REQUEST_TEMPLATE.md
README.md
tsconfig.json
tslint.json
uml.png

# Installation Guide

1. Get the code

git clone https://github.com/inversify/inversify-basic-example

Downloads the entire project code from GitHub to your computer.

cd inversify-basic-example

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

$ npm install

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# inversify-basic-example
[![Join the chat at https://gitter.im/inversify/inversify-basic-example](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/inversify/InversifyJS)
[![Build Status](https://secure.travis-ci.org/inversify/inversify-basic-example.svg?branch=master)](https://travis-ci.org/inversify/inversify-basic-example)
[![Dependencies](https://david-dm.org/inversify/inversify-basic-example.svg)](https://david-dm.org/inversify/inversify-basic-example#info=dependencies)
[![img](https://david-dm.org/inversify/inversify-basic-example/dev-status.svg)](https://david-dm.org/inversify/inversify-basic-example/#info=devDependencies)
[![img](https://david-dm.org/inversify/inversify-basic-example/peer-status.svg)](https://david-dm.org/inversify/inversify-basic-example/#info=peerDependenciess)

A basic example that showcases how to setup InversifyJS

This is a very basic InversifyJS example.

This program declares: 
- Three interfaces `Warrior`, `Weapon` and `Battle`.
- Two implementations of `Weapon`: `Katana` and `Shuriken`
- Two implementations of `Warrior`: `Ninja` and `Samurai`
- One implementation of `Battle`: `EpicBattle`.

The warriors own a weapon and are tagged with some metadata.

![](https://raw.githubusercontent.com/inversify/inversify-basic-example/master/uml.png)

We use some constraints `whenTargetNamed` and `whenParentNamed` to indicate which
`Weapon` should be injected into and implementation of `Warrior` and which implementation
of `Warrior` should injected into `EpicBattle`:

```ts
container.bind<Warrior>(SERVICE_IDENTIFIER.WARRIOR).to(Ninja).whenTargetNamed(TAG.CHINESE);
container.bind<Warrior>(SERVICE_IDENTIFIER.WARRIOR).to(Samurai).whenTargetNamed(TAG.JAPANESE);
container.bind<Weapon>(SERVICE_IDENTIFIER.WEAPON).to(Shuriken).whenParentNamed(TAG.CHINESE);
container.bind<Weapon>(SERVICE_IDENTIFIER.WEAPON).to(Katana).whenParentNamed(TAG.JAPANESE);
container.bind<Battle>(SERVICE_IDENTIFIER.BATTLE).to(EpicBattle);
```

# How can I run it?
You can clone it using:

```
$ git clone https://github.com/inversify/inversify-basic-example.git
```

To run this example you need to install some dependencies:

```
$ cd inversify-basic-example
$ npm install
```

And compile the TypeScript code into JavaScript code:

```
$ gulp
```

The generated code is available at the `dist` directory.

At this point you are ready to run the example:

```
$ node dist/main.js
```

You should see the following in console:

```
FIGHT!
                Ninja (Shuriken)
                vs
                Samurai (Katana)
```