# vdi

> vue3 Dependency injection And some small functions

Latest version **1.8.0** (published 2025-03-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install vdi
pnpm add vdi
yarn add vdi
bun add vdi
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.8.0 |
| Published | 2025-03-07 |
| First published | 2022-05-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 18 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Jinghui_S |
| Maintainers | shijinghui |
| Keywords | vue, di, vue-di |

## Links

- npm: https://www.npmjs.com/package/vdi
- Repository: https://github.com/JinghuiS/vdi
- Issues: https://github.com/JinghuiS/vdi/issues
- npm.io page: https://npm.io/package/vdi

## Dependencies (4)

- [vue](https://npm.io/package/vue.md) ^3.5.13
- [vue-router](https://npm.io/package/vue-router.md) ^4.3.2
- [@vueuse/core](https://npm.io/package/@vueuse/core.md) ^12.8.2
- [@wendellhu/redi](https://npm.io/package/@wendellhu/redi.md) ^0.17.1

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.8.0 (latest) — 2025-03-07
- 1.7.0 — 2024-05-28
- 1.6.1 — 2023-09-08
- 1.6.0 — 2023-09-07
- 1.5.1 — 2023-06-01
- 1.5.0 — 2023-06-01
- 1.4.0 — 2023-02-16
- 1.3.0 — 2023-02-10
- 1.2.2 — 2023-02-03
- 1.2.1 — 2023-02-03
- 1.2.0 — 2023-02-03
- 1.1.0 — 2023-02-02
- 1.0.0 — 2023-02-01
- 0.5.0 — 2023-01-28
- 0.4.7 — 2023-01-09
- … 23 more at https://npm.io/package/vdi/versions

## README

# Vdi

一个简单的 vue di 插件，基于`@wendellhu/redi`实现

-   [docs](https://vdi-docs.vercel.app/)

## 破坏性更新
1.0版本删除了vue-module，overlay相关的api，如果你在使用vue-module overlay请继续留在0.5.0版本

## 安装

```bash
$ npm install @wendellhu/redi vdi
```

## 功能

-   更好的依赖注入  
    基于 `redi` 增强 vue3 依赖注入

-   简单使用，非侵入  
    最少两个 api 就可以完成强大的依赖注入

## 例子

### 简单使用

创建服务

```ts
// count.service.ts
import { ref } from 'vue'
export class CountService {
    count = ref<number>(0)
    inc() {
        this.count.value++
    }
}
```

页面注入并使用

```vue
<!--Father.vue -->
<script setup lang="ts">
import { onProvider, useDependency } from 'vdi'

import { CountService } from './count.service'

//在当前组件注入依赖
onProvider([[CountService]])

//获取提供的依赖，self为true时候获取的是当前组件的依赖
const countService = useDependency(CountService, { self: true })
</script>

<template>
    {{ countService.count }}
    <button @click="countService.inc">修改</button>
</template>
```

在子组件使用

```vue
<!--Child.vue -->
<script setup lang="ts">
import { onProvider, useDependency } from 'vdi'

import { CountService } from './count.service'

//获取提供的依赖，不需要使用self，因为父组件已经注入了依赖
const countService = useDependency(CountService)
</script>

<template>
    <div class="child">
        子组件： {{ countService.count }}
        <button @click="countService.inc">count+</button>
    </div>
</template>
```

## License

[MIT](https://github.com/JinghuiS/vdi/blob/main/LICENSE)

---
_Source: https://npm.io/package/vdi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
