@gigya-ts/web-sdk

中文文档
0.1.21发布于 2025/10/15TypeScriptES Module近 30 天下载 4256

TypeScript definitions for the Gigya Web SDK

原始使用文档
文档目录4 节
  1. Installation
  2. Usage
  3. 0. (Optional) Define your custom Gigya schemas
  4. 1. Extend the global window with the gigya types

@gigya-ts/web-sdk

Add type-safety to a Gigya Web SDK project.

See @gigya-ts/gigya if you are using the Gigya REST API instead (even from the browser!).

Installation

Install the @gigya-ts/gigya package from your package manager of choice:

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

Usage

0. (Optional) Define your custom Gigya schemas

See adding custom schemas to define your custom schemas (data, preferences, etc.) so that response types from the Web SDK include your custom fields.

1. Extend the global window with the gigya types

Extend the global window with the Gigya Web SDK, including your schemas:

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

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

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

Once the global window has been extended, you can use the Web SDK as you normally would:

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

版本与发布记录

@gigya-ts/web-sdk 共发布 29 个版本,首次发布于 2024/03/17;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.21latest2025/10/151.1 年前
0.1.202025/09/171.2 年前
0.1.192025/04/111.6 年前
0.1.182025/04/101.6 年前
0.1.172025/04/021.6 年前
0.1.162025/04/021.6 年前

关于 @gigya-ts/web-sdk 的常见问题

@gigya-ts/web-sdk 是什么?

TypeScript definitions for the 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 和提交记录判断。