# @craftercms/search 中文文档

规范地址：https://npmcn.com/package/%40craftercms/search/

版本：4\.3\.0
npm 元数据更新时间：2025-02-20T17:49:48.394Z
中文译文更新时间：2026-11-10T22:56:29.376Z
软件包许可：GNU LGPL 3\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40craftercms/search
原文对照：https://npmcn.com/package/%40craftercms/search/?lang=original
项目主页：https://github.com/craftercms/craftercms-sdk-js#readme
源码仓库：https://github.com/craftercms/craftercms-sdk-js

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

- 包体积（解压后）：147 kB，34 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2018-07-30T19:09:44.496Z
- 最新版本发布：2025-02-20T17:49:48.206Z
- 近 30 天下载量：2869（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：35（近 12 个月 0 个）

## 中文简介

CRafter CMS 搜索服务和相关工具

## 安装

```sh
npm install @craftercms/search
```

也可以使用：`pnpm add @craftercms/search`、`yarn add @craftercms/search`、`bun add @craftercms/search`

## README

![npm (scoped)](https://img.shields.io/npm/v/@craftercms/search?style=plastic)

# @ cravercms/ 搜索

此软件包包含将您的应用程序与 Crafter 搜索集成的工具 .

## 使用量

所有 Crafter CMS 包都可以通过 npm 使用,也可以通过常规脚本导入在 plain html/javascript中使用.

### 通过 npm

-   使用 `yarn` 或者说 `npm`
    -   `yarn add @craftercms/search` 或者说
    -   `npm install @craftercms/search`
-   导入和使用您需要的服务

### Via html 脚本导入

-   下载捆绑并在您的页面中导入 .
-   捆绑声明一个名为全局变量 `craftercms`。 您可以在此根下访问所有 Frapercms 的软件包和函数.
-   这个 `search` 软件包取决于 `rxjs`, (中文(简体) ), `@craftercms/utils`, (中文(简体) ), `@craftercms/classes`; 保证在 `search` 剧本.

**提示**: 一旦导入脚本, 类型 `craftercms` 在浏览器的 dev 工具控制台上检查软件包

#### Vanilla html/js 实例

```html
<script src="https://unpkg.com/rxjs"></script>
<script src="https://unpkg.com/@craftercms/utils"></script>
<script src="https://unpkg.com/@craftercms/classes"></script>
<script src="https://unpkg.com/@craftercms/content"></script>
<script src="https://unpkg.com/@craftercms/search"></script>
<script>
 (function ({ search, content }, { operators }) {

   const { map } = operators;
   const { search, createQuery } = search;
   const { parseDescriptor, preParseSearchResults } = content;

   search(
     createQuery({
       query: {
         bool: {
           filter: [/*...*/]
         }
       }
     }),
     { baseUrl: 'http://localhost:8080', site: 'editorial' }
   ).pipe(
     map(({ hits, ...rest }) => ({
       ...rest,
       hits: hits.map(({ _source }) => parseDescriptor(
         preParseSearchResults(_source)
       ))
     }))
   ).subscribe((results) => {
     // Do stuff with results...
   });

 })(craftercms, rxjs);
</script>
```

## 软件包索引

以下示例假设使用方式为 npm 。 如果你在使用捆绑, 直接导入浏览器中的脚本, 这些功能将在全局变量下 名称 `craftercms.search` (即说. `window.craftercms.search`) (中文(简体) ).

### 搜索

返回给定查询的结果.

`search(query: Query)`

| 参数 |  |
| --- | :-: |
| 查询 | 查询对象 |
| 配置 | 整齐配置 。 可选的 默认值在 [这里](https://npmcn.com/package/%40craftercms/models/README.md#CrafterConfig)。 。 。 . |

#### 回返

地图模型

#### 实例

-   连接到 Crafter Search 以查询使用 ELASTIC SEARCH 的内容 :

```typescript
  import { crafterConf } from '@craftercms/classes';
  import { search, createQuery } from '@craftercms/search';
  import { map } from 'rxjs/operators';
  import { parseDescriptor, preParseSearchResults } from '@craftercms/content';

  // First, set the Crafter configuration to cache your config. 
  // All subsequent calls to `getConfig` will use that configuration.
  crafterConf.configure({
    baseUrl: 'http://localhost:8080',
    site: 'wordify'
  });

  const query = 'lorem';
  const fields = ['headline_s', 'blurb_t'];
  const contentTypes = ['/page/post', '/component/post'];
  search(
    createQuery({
      query: {
        'bool': {
          'filter': [
            { 'bool': { 'should': contentTypes.map(id => ({ 'match': { 'content-type': id } })) } },
            { 'multi_match': { 'query': query, 'fields': fields } }
          ]
        }
      }
    }),
    // If you didn't pre-configure, you may send config values as second param here
    // { baseUrl: 'http://localhost:8080', site: 'wordify' }
  ).pipe(
    map(({ hits, ...rest }) => {
      return { 
        ...rest, 
        hits: hits.map(({ _source }) => parseDescriptor(
          preParseSearchResults(_source)
        )) 
      };
    })
  ).subscribe((results) => {
    console.log(results);
  });
```

您可通过在调用时间的服务呼叫中提供配置对象来使用不同的配置 .

```typescript
  import { search, createQuery } from '@craftercms/search';

  //Create query
  const query = createQuery({
    "query" : {
        "match_all" : {}
    }
  });

  search(query, { baseUrl: 'http://localhost:8080', site: 'editorial' }).subscribe((results) => {
    // ...
  });
```

## 常见问题

### @craftercms/search 是什么？

CRafter CMS 搜索服务和相关工具

### 如何安装 @craftercms/search？

在项目目录运行 npm install @craftercms/search，或使用 pnpm add / yarn add / bun add。

### @craftercms/search 支持 TypeScript 吗？

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

### @craftercms/search 支持 ESM 还是 CommonJS？

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

### @craftercms/search 可以商用吗？

@craftercms/search 使用 GNU LGPL 3\.0 许可。声明的许可为 GNU LGPL 3\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @craftercms/search 的下载量有多少？

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

### @craftercms/search 还在维护吗？

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