# @databiosphere/bard-client 中文文档

规范地址：https://npmcn.com/package/%40databiosphere/bard-client/

版本：0\.1\.0
npm 元数据更新时间：2023-04-21T13:43:03.235Z
中文译文更新时间：2026-11-11T14:06:06.180Z
软件包许可：BSD-3-Clause

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

原始 npm 页面：https://www.npmjs.com/package/%40databiosphere/bard-client
原文对照：https://npmcn.com/package/%40databiosphere/bard-client/?lang=original

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

- 包体积（解压后）：20.3 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2020-08-19T17:54:45.814Z
- 最新版本发布：2020-08-26T13:03:23.656Z
- 近 30 天下载量：2759（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

JavaScript 库,用于整个 DSP 共享客户端侧分析

## 安装

```sh
npm install @databiosphere/bard-client
```

也可以使用：`pnpm add @databiosphere/bard-client`、`yarn add @databiosphere/bard-client`、`bun add @databiosphere/bard-client`

## README

# 取消客户端

JavaScript 库,用于整个 DSP 共享客户端侧分析

# 概览

此库由自定义解析码在 Data 中导入 科学平台 (DSP) web UIs 如Terra和单细胞门户. 它供应 它们具有整个DSP共同的属性,如"参考器","浏览器"等, "屏幕宽度" 还有更多.

这些自定义分析模块 : [条形服务器](https://github.com/DataBiosphere/bard),它寄给Mixpanel.

最终,这个图书馆可以扩大,包括两个功能 `logToBard` 函数,以及或默认的事件工具化,但目前其重点是 将一组事件属性标准化.

# 安装

安装条形客户端 [国家防范机制](https://www.npmjs.com/package/@databiosphere/bard-client) 像这样:

```
yarn add @databiosphere/bard-client
```

# 使用量

下面是一个简化的自定义分析模块.

通过为Bard客户端添加两行代码 - 导入和调用DefaultProperties - 我们可以增强这些自定义 在所有 DSP 中共享默认属性的分析.

```
import { getDefaultProperties } from '@databiosphere/bard-client' // Import the function from Bard client

function logToBard(name, customProps={}) {
  const appPath = trimPrivateData(window.location.pathname)

  const props = Object.assign(customProps, {
    appId: 'awesome-dsp-web-ui',
    appPath
  }, getDefaultProperties()) // Append the default properties to the payload sent to Bard

  const body = {
    body: JSON.stringify({
      event: name,
      properties: props
    })
  }

  const defaultInit = {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    }
  }

  const init = Object.assign(defaultInit, body)

  fetch(`${bardDomain}/api/event`, init)

```

## 常见问题

### @databiosphere/bard-client 是什么？

JavaScript 库,用于整个 DSP 共享客户端侧分析

### 如何安装 @databiosphere/bard-client？

在项目目录运行 npm install @databiosphere/bard-client，或使用 pnpm add / yarn add / bun add。

### @databiosphere/bard-client 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/databiosphere\_\_bard-client 是否存在。

### @databiosphere/bard-client 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @databiosphere/bard-client 可以商用吗？

@databiosphere/bard-client 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### @databiosphere/bard-client 的下载量有多少？

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

### @databiosphere/bard-client 还在维护吗？

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