# @geckosoft/ngx-query-params 中文文档

规范地址：https://npmcn.com/package/%40geckosoft/ngx-query-params/

版本：0\.0\.6
npm 元数据更新时间：2025-03-24T17:55:33.007Z
中文译文更新时间：2026-11-16T01:54:14.105Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40geckosoft/ngx-query-params
原文对照：https://npmcn.com/package/%40geckosoft/ngx-query-params/?lang=original

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

- 包体积（解压后）：15.8 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@angular/core \>= 17 \< 21，@angular/router \>= 17 \< 21
- 首次发布：2025-03-24T16:49:20.405Z
- 最新版本发布：2025-03-24T17:55:32.805Z
- 近 30 天下载量：1976（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

反应和类型安全查询参数管理 **角信号**。 。 。 .

## 安装

```sh
npm install @geckosoft/ngx-query-params
```

也可以使用：`pnpm add @geckosoft/ngx-query-params`、`yarn add @geckosoft/ngx-query-params`、`bun add @geckosoft/ngx-query-params`

## README

# ngx-query-参数

反应和类型安全查询参数管理 **角信号**。 。 。 .

> 由Angular现代反应模式提供动力.

* * *

## \* 特性

-   ✅ **自动符号** 从查询参数
-   ✅ **双向绑定**: 更新信号 – 更新 URL
-   ++ 与原始类型、阵列、布林、数字、enum 等工作
-   ✅ **完全可动摇的树**角-内置
-   零额外依赖

* * *

## \* 安装

利用国家预防机制:

```bash
npm install @geckosoft/ngx-query-params
```

使用 YARN :

```bash
yarn add @geckosoft/ngx-query-params
```

* * *

## QQ 设置

保证您的应用使用 Angular 的 **信号** (英语:Angular v17+).

不需要特别的设置——只需在任何角构件或服务中导入和使用.

* * *

## 使用量

### 绑上一个数字参数:

```ts
import { Component } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { qpNum } from '@geckosoft/ngx-query-params';

@Component({
  selector: ...,
  imports: [FormsModule],
  template: `
    <input type="number" [(ngModel)]="page">
    <button (click)="nextPage()">Next Page</button>
  `,
})
export class MyComponent {
  page = qpNum('page', 1); // ?page=1

  nextPage() {
    this.page.set(this.page() + 1);
  }
}
```

### 装入布尔参数 :

```ts
toggle = qpBool('debug', false); // ?debug=true
```

### 绑入字符串参数 :

```ts
filter = qp('filter', 'all'); // ?filter=all
```

### 可选单个参数:

```ts
sort = qp('sort'); // string | undefined
```

### 类似倒铸 :

```ts
type Tab = 'home' | 'profile' | 'settings';
tab = qpCast1<Tab>('tab', 'home'); // ?tab=home
```

### 多值参数 :

```ts
tags = qpMapN('tag', (x) => x.toLowerCase()); // ?tag=a&tag=b
```

* * *

## \* 如何运作

-   钩入角路由器 `ActivatedRoute` 财务报告和审定财务报表 `queryParamMap`
-   同步为 `WritableSignal<T>`
-   全球 `QueryParamsService` 当任何参数发生变化时, 批次并更新 URL

* * *

## API 参考

### 信号

| 函数 | 类型 | 说明 |
| --- | --- | --- |
| `qp()` | `WritableSignal<string | undefined>` | 字符串参数 |
| `qpNum()` | `WritableSignal<number | undefined>` | 编号参数 |
| `qpBool()` | `WritableSignal<boolean | undefined>` | 布尔参数 |
| `qpCast1<T>()` | `WritableSignal<T | undefined>` | 铸至铝/合金类型 |
| `qpMapN()` | `WritableSignal<T[]>` | 多值参数与映射 |
| `qpMap1()` | `WritableSignal<T | undefined>` | 一般一值映射仪 |

* * *

## 高级

可以注射吗 `QueryParamsService` 手动批量或设置多个参数:

```ts
constructor(private readonly qps: QueryParamsService) {}

applyFilters() {
  this.qps.set('filter', 'recent');
  this.qps.set('limit', 20);
}
```

* * *

## 清理

不需要手动取消订阅- 内部处理 `onDestroy()` 和信号处理.

* * *

## 许可证

麻省理工学院

* * *

## \* 反馈/贡献

问题和公关欢迎!

## 常见问题

### @geckosoft/ngx-query-params 是什么？

反应和类型安全查询参数管理 角信号。 。 。 \.

### 如何安装 @geckosoft/ngx-query-params？

在项目目录运行 npm install @geckosoft/ngx-query-params，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@angular/core（\>= 17 \< 21）、@angular/router（\>= 17 \< 21）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @geckosoft/ngx-query-params 支持 TypeScript 吗？

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

### @geckosoft/ngx-query-params 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @geckosoft/ngx-query-params 可以商用吗？

@geckosoft/ngx-query-params 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @geckosoft/ngx-query-params 的下载量有多少？

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

### @geckosoft/ngx-query-params 还在维护吗？

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

