# @gigya-ts/web-sdk 中文文档

规范地址：https://npmcn.com/package/%40gigya-ts/web-sdk/

版本：0\.1\.21
npm 元数据更新时间：2025-10-15T09:00:47.418Z
中文译文更新时间：2026-11-16T08:51:29.730Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40gigya-ts/web-sdk
原文对照：https://npmcn.com/package/%40gigya-ts/web-sdk/?lang=original

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

- 包体积（解压后）：25.2 kB，21 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2024-03-17T15:31:17.941Z
- 最新版本发布：2025-10-15T09:00:47.138Z
- 近 30 天下载量：4256（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 0 个）

## 中文简介

Gigya Web SDK 的脚本定义

## 安装

```sh
npm install @gigya-ts/web-sdk
```

也可以使用：`pnpm add @gigya-ts/web-sdk`、`yarn add @gigya-ts/web-sdk`、`bun add @gigya-ts/web-sdk`

## README

# @gigya-ts/web-sdk (英语)

将类型安全添加到 a [Gigya 网络 SDK](https://help.sap.com/docs/SAP_CUSTOMER_DATA_CLOUD/8b8d6fffe113457094a17701f63e3d6a/417f6b5e70b21014bbc5a10ce4041860.html) 项目.

见 [@gigya-ts/gi](https://npmcn.com/packages/gigya/README.md) 如果你正在使用 [Gigya REST API (英语)](https://help.sap.com/docs/SAP_CUSTOMER_DATA_CLOUD/8b8d6fffe113457094a17701f63e3d6a/416d906d70b21014bbc5a10ce4041860.html) 相反(甚至从浏览器!).

## 安装

[![](https://pkg-size.dev/badge/bundle/0 "Bundle size for @gigya-ts/web-sdk")](https://pkg-size.dev/@gigya-ts/web-sdk)

安装您选择的软件包管理器中的 @ gigya- ts/ gigya 软件包 :

```bash
# npm
npm add @gigya-ts/web-sdk
# pnpm
pnpm add @gigya-ts/web-sdk
```

## 使用量

### 0 (可选) 定义您的自定义 Gigya 方案

见 [添加自定义方案](https://npmcn.com/docs/adding-custom-schemas.md) 定义您的自定义计划( 数据、 首选项等) , 以便来自 Web SDK 的响应类型包含您的自定义字段.

### 1\. 扩大全球窗口,使之包括: `gigya` 类型

以 Gigya Web SDK 扩展全球窗口, 包括您的计划 :

```typescript
// my-gigya.ts
import { GigyaWebSDK } from '@gigya-ts/web-sdk';

declare global {
    interface Window {
        onGigyaServiceReady?: () => void;

        gigya?: GigyaWebSDK<MyAccountSchema, MyPreferencesSchema, MySubscriptionsSchema>;
    }
}
```

一旦全球窗口被扩展,您可以像通常那样使用Web SDK:

```typescript
window.onGigyaServiceReady = () => {
    window.gigya?.accounts.getAccountInfo({
        callback: (response) => {
            console.log('gigya.account.getAccountInfo response', response);
        },
    });
};
```

## 常见问题

### @gigya-ts/web-sdk 是什么？

Gigya Web SDK 的脚本定义

### 如何安装 @gigya-ts/web-sdk？

在项目目录运行 npm install @gigya-ts/web-sdk，或使用 pnpm add / yarn add / bun add。

### @gigya-ts/web-sdk 支持 TypeScript 吗？

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

### @gigya-ts/web-sdk 支持 ESM 还是 CommonJS？

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

### @gigya-ts/web-sdk 可以商用吗？

@gigya-ts/web-sdk 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @gigya-ts/web-sdk 的下载量有多少？

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

### @gigya-ts/web-sdk 还在维护吗？

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

