Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/needle-di/core
A lightweight, type-safe Dependency Injection (DI) library for JavaScript and TypeScript projects
https://github.com/needle-di/core
dependency-injection typescript
Last synced: 6 days ago
JSON representation
A lightweight, type-safe Dependency Injection (DI) library for JavaScript and TypeScript projects
- Host: GitHub
- URL: https://github.com/needle-di/core
- Owner: needle-di
- License: mit
- Created: 2024-09-17T13:37:35.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-16T14:26:15.000Z (26 days ago)
- Last Synced: 2025-01-16T14:31:37.595Z (26 days ago)
- Topics: dependency-injection, typescript
- Language: TypeScript
- Homepage: http://needle-di.io
- Size: 258 KB
- Stars: 30
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - needle-di/core - A lightweight, type-safe Dependency Injection (DI) library for JavaScript and TypeScript projects (TypeScript)
README
# Needle DI 💉
> A lightweight, type-safe Dependency Injection (DI) library for JavaScript and TypeScript projects.
[](https://www.npmjs.com/package/@needle-di/core)
[](https://jsr.io/@needle-di/core)
[](https://www.npmjs.com/package/@needle-di/core)
[](https://github.com/needle-di/core/actions/workflows/ci.yml)
[](https://github.com/needle-di/core/actions/workflows/ci.yml)
Needle DI is a lightweight, TypeScript-first library for dependency injection (DI). It is designed to be both easy to use and highly efficient.
### Key Features
- Stand-alone: No additional dependencies required
- Intended for both JavaScript-only and TypeScript projects
- Supports [tree-shakeable injection tokens](https://needle-di.io/advanced/tree-shaking.html): optimize your builds for production.
- Inspired by [Angular](https://angular.dev/) and [InversifyJS](https://github.com/inversify/InversifyJS), familiar to developers coming from these frameworks.
- Uses native [ECMAScript decorators](https://github.com/tc39/proposal-decorators) (currently stage 3)
- No need for `experimentalDecorators` and `emitDecoratorMetadata`
- No reflection libraries needed, like `reflect-metadata` or other reflection mechanisms.
## Basic example
Here’s a simple example using constructor injection to inject one service into another.
```typescript
import { injectable, inject } from "@needle-di/core";
@injectable()
class FooService {}
@injectable()
class BarService {
constructor(private fooService = inject(FooService)) {}
// ^? Type will be inferred as `FooService`
}
```
The `@injectable` decorator eliminates the need to manually register services. To construct the `BarService`, create a
dependency injection container, and use the `container.get()` method:
```typescript
import { Container } from "@needle-di/core";
const container = new Container();
const barService = container.get(BarService);
// ^? Type will be inferred as `BarService`
```
Check out the [docs](https://needle-di.io/concepts/binding.html) to learn more!
## Installation
```
npm install --save @needle-di/core
```
Needle DI also works with [Deno](https://deno.com/) and is published to [JSR](https://jsr.io/@needle-di/core) as well:
```bash
deno add jsr:@needle-di/core
```
## Docs
Check out our docs on [https://needle-di.io](https://needle-di.io/concepts/binding.html).
## License
License under the MIT License (MIT)
Copyright (c) 2024 Dirk Luijk
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.