InversifyJS README

The project's README from github.com/inversify/InversifyJS. As one markdown file: README.md.

[!NOTE]
InversifyJS will be moving to the monorepo. Please, consider creating issues and pull requests there.

Next releases will be published in the monorepo, so consider starring it to be notified.

NPM version NPM Downloads Docs Codecov

GitHub stars Discord Server

InversifyJS

A powerful and lightweight inversion of control container for JavaScript & Node.js apps powered by TypeScript.

📕 Documentation

Documentation is available at https://inversify.io

About

InversifyJS is a lightweight inversion of control (IoC) container for TypeScript and JavaScript apps. An IoC container uses a class constructor to identify and inject its dependencies. InversifyJS has a friendly API and encourages the usage of the best OOP and IoC practices.

Motivation

JavaScript now supports object oriented (OO) programming with class based inheritance. These features are great but the truth is that they are also dangerous.

We need a good OO design (SOLID, Composite Reuse, etc.) to protect ourselves from these threats. The problem is that OO design is difficult and that is exactly why we created InversifyJS.

InversifyJS is a tool that helps JavaScript developers write code with good OO design.

Philosophy

InversifyJS has been developed with 4 main goals:

  1. Allow JavaScript developers to write code that adheres to the SOLID principles.

  2. Facilitate and encourage the adherence to the best OOP and IoC practices.

  3. Add as little runtime overhead as possible.

  4. Provide a state of the art development experience.

Testimonies

Nate Kohari - Author of Ninject

"Nice work! I've taken a couple shots at creating DI frameworks for JavaScript and TypeScript, but the lack of RTTI really hinders things. The ES7 metadata gets us part of the way there (as you've discovered). Keep up the great work!"

Michel Weststrate - Author of MobX

Dependency injection like InversifyJS works nicely

Some companies using InversifyJS

Acknowledgements

Thanks a lot to all the contributors, all the developers out there using InversifyJS and all those that help us to spread the word by sharing content about InversifyJS online. Without your feedback and support this project would not be possible.

License

License under the MIT License (MIT)

Copyright © 2015-2017 Remo H. Jansen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

InversifyJS (inversify/InversifyJS)

Searching Database…

Что это такое?InversifyJS — это легковесный контейнер инверсии управления (IoC) для приложений на TypeScript и JavaScript — библиотека, которая решает, как ваши классы получают нужные им объекты.
А что контейнер IoC делает на практике?Он через конструктор класса определяет его зависимости и внедряет их, то есть класс получает нужные объекты снаружи, а не создаёт их сам. API построен так, чтобы поощрять лучшие практики ООП и IoC.
Как добавить его в свой проект?Установите пакет inversify из npm, затем по документации, на которую ведёт ссылка в README, объявите привязки и научитесь получать экземпляры классов. Проект поставляется в сборках и CommonJS, и ESM.
Мне обязательно нужен TypeScript или подойдёт обычный JavaScript?Библиотека написана на TypeScript и ориентирована на JavaScript и Node.js, поэтому обычный JavaScript работает, но TypeScript даёт максимум возможностей. Это библиотека внутри приложения — ни сервер, ни дополнительный рантайм разворачивать не нужно.
Что мне стоит знать об этом репозитории перед началом работы?Да — проект переезжает в монорепозиторий inversify: новые issues, пулл-реквесты и релизы публикуются там, так что следите за github.com/inversify/monorepo, а не за этим репозиторием.
Это для создателей фреймворков или для обычных разработчиков приложений?Для обычных JavaScript-разработчиков: в README библиотека позиционируется как инструмент, который помогает писать код с хорошим объектно-ориентированным дизайном, с дружелюбным API и минимальными накладными расходами в рантайме.
Можно пользоваться бесплатно, в том числе в коммерческих проектах?Да. Лицензия MIT — бесплатно использовать, копировать, изменять, объединять, публиковать и передавать в сублицензии, платных тарифов нет.
Зачем делать DI-контейнер, если можно просто создавать классы там, где они нужны?Потому что классический ООП в JavaScript легко испортить: в README говорится, что без хорошего объектно-ориентированного дизайна (SOLID, Composite Reuse) эти возможности опасны, а поскольку такой дизайн делать непросто, авторы и создали InversifyJS, чтобы помочь.
Под что авторы оптимизировали библиотеку?Четыре цели: помогать разработчикам писать код, соответствующий принципам SOLID, поощрять лучшие практики ООП и IoC, добавлять как можно меньше накладных расходов в рантайме и дать разработку на уровне современных стандартов.
Это проверенная временем библиотека или любительский проект?Проект существует с 2015 года (копирайт 2015-2017 автора Remo H. Jansen), у него около 12 000 звёзд на GitHub, а в README перечислены компании, использующие его в продакшене, — правда, их названия показаны только логотипами.
Что говорят о ней авторы других фреймворков?Nate Kohari, автор DI-фреймворка Ninject, высоко оценил, как подход с метаданными ES7 обходит отсутствие RTTI в JavaScript, а создатель MobX Michel Weststrate написал, что внедрение зависимостей вроде InversifyJS работает отлично.
Creator
inversify
Size
3.4 MB
Stars
12.1K
Age
11y
Commits · 90 Days