# @datorama/akita-ng-effects 中文文档

规范地址：https://npmcn.com/package/%40datorama/akita-ng-effects/

版本：1\.0\.6
npm 元数据更新时间：2023-09-14T13:24:33.827Z
中文译文更新时间：2026-11-14T16:38:34.839Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40datorama/akita-ng-effects
原文对照：https://npmcn.com/package/%40datorama/akita-ng-effects/?lang=original
项目主页：https://github.com/datorama/akita/tree/master/libs/akita-ng-effects#readme
源码仓库：https://github.com/datorama/akita

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：226 kB，83 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：@datorama/akita \>= 6\.0\.0，@angular/core \>= 8\.0\.0，@angular/common \>= 8\.0\.0，rxjs \*，tslib ^2\.0\.0
- 首次发布：2020-12-23T16:05:23.088Z
- 最新版本发布：2021-11-10T12:48:14.893Z
- 近 30 天下载量：1978（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 0 个）

## 中文简介

反应式国家管理扩展处理副作用.

## 安装

```sh
npm install @datorama/akita-ng-effects
```

也可以使用：`pnpm add @datorama/akita-ng-effects`、`yarn add @datorama/akita-ng-effects`、`bun add @datorama/akita-ng-effects`

## README

# 秋田效应

秋田的目标是提供一个简单的API,使您能够使用面向对象的模式来管理应用程序中的状态. 在您的应用程序中引入效果是完全可选的, 允许您执行非常复杂的事件架构

-   ~ 学习它 [文件站点](https://datorama.github.io/akita/docs/angular/effects)
-   在行动上看 [堆叠布立茨](https://stackblitz.com/github/yackinn/akita-ng-effects-example)
-   使用 [国 际](https://github.com/datorama/akita/tree/master/cli)

### 这是什么?

使用效果连接到您的动作,并在动作事件时采取行动.  

### 怎样用

在AkitaNgeffectsModule上记录一下你的效应.

```ts
// Only use .forRoot() once in your base module.
@NgModule({
  imports: [
    CommonModule, 
    AkitaNgEffectModule.forRoot([NavigationEffects])
  ],
})
export class CoreDataModule {}

// Use .forFeature() on any feature module
@NgModule({
  imports: [
    CommonModule, 
    AkitaNgEffectModule.forFeature([NavigationEffects])
  ],
})
export class FeatureModule {}

```

## 使用量

安排你的动作, 效果会听. 行动活动在全球发布在行动流上,以便每一种效果都能听到任何行动.

```ts
export const LOAD_MAIN_NAVIGATION = createAction('Load Main Navigation');
export const LOAD_MAIN_NAVIGATION_SUCCESS = createAction(
  'Load Main Navigation Success', 
  props<{ mainNav: MainNavigation }>()
);
```

使用效果来听到任何动作事件 。 您可以在任何动作事件上发布其它动作或运行服务任务.

```ts
@Injectable({
  providedIn: 'root',
})
export class NavigationEffects {
  constructor(
    // inject the actions stream
    private actions$: Actions, 
    private navigationService: NavigationService, 
    private store: NavigationStore
  ) {}

  // can also be immplemented with createEffect() function
  @Effect()
  loadMainNavigation$ = this.actions$.pipe(
    ofType(LOAD_MAIN_NAVIGATION),
    switchMap(() => this.navigationService.LOAD_MAIN_NAVIGATION().pipe(
      tap(mainNav => this.actions$.dispatch(loadMainNavigationSuccess({ mainNav }))))
    )
  );

  @Effect()
  loadMainNavigationSuccess$ = this.actions$.pipe(
    ofType(loadMainNavigationSuccess),
    map(({ mainNav }) => this.navigationService.updateNavigationTree(mainNav)),
    tap(mainRoutes => this.store.updateNavigation(mainRoutes))
  );
}
```

一个可能的用例 一个在警卫内部的行动.  

```ts
@Injectable({
  providedIn: 'root',
})
export class InitRouterGuard implements CanActivate {
  constructor(
    private navigationQuery: NavigationQuery, 
    private actions: Actions
  ) {}

  canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean | UrlTree> {
    return this.navigationQuery.isNavInitialized$.pipe(
      tap((isInit) => {
        if (!isInit) this.actions.dispatch(loadMainNavigation());
      }),
      filter(isInit => isInit),
      map((val) => true)
    );
  }
}
```

## 常见问题

### @datorama/akita-ng-effects 是什么？

反应式国家管理扩展处理副作用\.

### 如何安装 @datorama/akita-ng-effects？

在项目目录运行 npm install @datorama/akita-ng-effects，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@datorama/akita（\>= 6\.0\.0）、@angular/core（\>= 8\.0\.0）、@angular/common（\>= 8\.0\.0）、rxjs（\*）、tslib（^2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @datorama/akita-ng-effects 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @datorama/akita-ng-effects 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @datorama/akita-ng-effects 可以商用吗？

@datorama/akita-ng-effects 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @datorama/akita-ng-effects 的下载量有多少？

根据 npm 官方下载统计，@datorama/akita-ng-effects 在 2026/10/12 – 2026/11/10 这 30 天内被下载 1,978 次，日均约 66 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @datorama/akita-ng-effects 还在维护吗？

最新版本 1\.0\.6 发布于 2021/11/10（5 年前）；至今共发布 9 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/12/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。