rxdb-vue
Vue 框架集成库,为 Vue 应用提供 RxDB 支持。基于 Vue Composables 实现响应式数据流。
功能特性
- Vue Composables 集成: 使用 useRxdb、useCollection 等组合式函数
- 组件库: 提供数据展示、编辑、表单等常用组件
- TypeScript 支持: 完整的类型定义
- 响应式更新: 数据变化自动触发组件更新
何时使用
- 构建 Vue 应用并需要本地优先数据库
- 需要响应式数据流与 Vue Composition API 无缝集成
- 需要离线优先的 Vue 应用
安装
npm install @aiao/rxdb @aiao/rxdb-vue
# 或
pnpm add @aiao/rxdb @aiao/rxdb-vue
使用
<script lang="ts" setup>
import { useRxdb } from '@aiao/rxdb-vue';
const { db } = await useRxdb();
</script>
完整示例
参考 dev-rxdb-vue 中的完整集成示例。
Fileoverview
RxDB Vue 集成包 提供 RxDB 数据库的 Vue 3 Composition API 接口
Interfaces
| Interface | Description |
|---|---|
| InfiniteScrollResource | - |
| RxDBResource | - |
Variables
| Variable | Description |
|---|---|
| injectRxDB | - |
| provideRxDB | - |
Functions
| Function | Description |
|---|---|
| makeRxDBDependencyInjector | RxDB 依赖注入 |
| useCount | Count entities matching the criteria |
| useCountAncestors | Count ancestor entities in a tree structure |
| useCountDescendants | Count descendant entities in a tree structure |
| useCountNeighbors | Count neighbor entities in a graph structure |
| useFind | Find multiple entities matching the criteria |
| useFindAll | Find all entities |
| useFindAncestors | Find all ancestor entities in a tree structure |
| useFindByCursor | 使用游标分页查找实体 |
| useFindDescendants | Find all descendant entities in a tree structure |
| useFindOne | 查找匹配条件的单个实体 |
| useFindOneOrFail | Find one entity or throw an error if not found |
| useGet | 通过 ID 获取单个实体 |
| useGraphNeighbors | Find neighbor entities in a graph structure |
| useGraphPaths | Find paths between two entities in a graph |
| useInfiniteScroll | 用于游标分页的无限滚动钩子 |
| useRxDB | - |