@getjoystick/joystick-js

中文文档
0.1.3发布于 2023/05/08MITTypeScriptESM + CJS近 30 天下载 2383

Javascript SDK 用于 Joystick

中文使用文档
文档目录10 节
  1. 安装
  2. 使用量
  3. 指定补充参数
  4. 其他请求选项
  5. 处理错误
  6. 缓存
  7. HTTP 客户端
  8. 测试
  9. 贷项
  10. 许可证

Javascript 客户端 Joystick 远程配置

Test code Latest Stable Version Total Downloads License

用Joystick的Javascript/Typescript JSON远程配置平台来简化您的应用程序或游戏开发进程. 容易地管理和更新配置,而不需要代码库繁杂或冗长的部署程序。 我们的现代平台提供先进的工作流程管理,自动化版本控制,并与任何Javascript或Typescript项目进行无缝整合. 此外,我们本地的多环境支持 与权限和审查工作流程 确保平稳操作 你整个团队会爱.

用Joystick体验简化配置管理的好处. 今天试一下我们的@getjoystick/joystick-js库,看看对你的应用或游戏动态来说有多容易,从根本上提升你的团队的工作流程.

安装

需要节点JS 16 后期. 通过 无数字 :

npm install @getjoystick/joystick-js

使用量

在您的 Javascript 或 Typescript 计划中使用 Joystick 来获取远程配置是一个微风 .

// Import the package.
import { Joystick } from "@getjoystick/joystick-js";

// Initialize a client with a Joystick API Key
const joystickClient = new Joystick({
  apiKey: process.env.JOYSTICK_API_KEY,
});

(async () => {
  // Request a single configuration
  const contentId1 = await joystickClient.getContent("content-id1");

  // Request a single configuration (typescript)
  const contentId1Typed = await joystickClient.getContent<TypeForContentId1>(
    "content-id1"
  );

  // Request multiple configurations at the same time
  const configurations = await joystickClient.getContents([
    "content-id1",
    "content-id2",
  ]);
  console.log(configurations);

  // {
  //     "content-id1": {...},
  //     "content-id2": {...}
  // }
})();

指定补充参数

当创建时 Joystick 对象,您可以指定额外的参数,用于所有的 API 调用 Joystick API 。 这些附加参数用于AB测试(userId),分化(params),和后向兼容的版本交付(semVer) (中文(简体) ).

详情见 API 文档。 。 。 .

// Initializing a client with options
const joystickClient = new Joystick({
  apiKey: process.env.JOYSTICK_API_KEY,
  semVer: "0.0.1",
  userId: "user-id-1",
  params: {
    param1: "value1",
    param2: "value2",
  },
  options: {
    cacheExpirationSeconds: 600, // default 600 (10 mins)
    serialized: false, // default false
  },
});

其他请求选项

fullResponse

在大多数情况下,你只需要配置的内容. 在高级用途中,如果想要处理AB测试或分解信息,可以指定 fullResponse 选项。 客户端会返回您的原始 API 响应 .

joystickClient
  .getContent("content-id1", { fullResponse: true })
  .then((getContentResponse) => console.log(getContentResponse));

// OR

joystickClient
  .getContents(["content-id1", "content-id2"], { fullResponse: true })
  .then((getContentsResponse) => console.log(getContentsResponse));

serialized

您可以将配置内容序列化 。 设定为 true,我们将通过查询参数 responseType=serialized 改为 欢乐棒 API。 。 。 .

joystickClient
  .getContent("content-id1", { serialized: true })
  .then((getContentResponse) => console.log(getContentResponse));

// OR

joystickClient
  .getContents(["content-id1", "content-id2"], { serialized: true })
  .then((getContentsResponse) => console.log(getContentsResponse));

可通过设置为每个API 响应设定全球序列化响应的选项 setSerialized(true) 初始化客户端时 :

const joystickClient = new Joystick({
  apiKey: process.env.JOYSTICK_API_KEY,
  options: {
    serialized: true,
  },
});

// OR

joystickClient.setSerialized(true);

refresh

在请求配置时忽略已有缓存 – 通过此选项为 true。 。 。 .

joystickClient
  .getContent("content-id1", { refresh: true })
  .then((getContentResponse) => console.log(getContentResponse));

// OR

joystickClient
  .getContents(["content-id1", "content-id2"], { refresh: true })
  .then((getContentsResponse) => console.log(getContentsResponse));

处理错误

客户端可以提出不同种类的例外,但基类为: JoystickError。 。 。 .

try {
  await joystickClient.getContents(["content-id1", "content-id2"]);
} catch (e) {
  if (e instanceof ApiHttpError) {
    // Handle HTTP error (i.e. timeout, or invalid HTTP code)
  } else if (e instanceof MultipleContentsApiException) {
    // Handle API exception (i.e. content is not found, or some of the keys can't be retrieved)
  }
}

缓存

默认情况下,客户端使用 记忆缓存,基于Map,这意味着在应用程序重新启动后缓存将被去除.

您可以通过执行接口指定自己的缓存执行 Sdk 缓存。 。 。 .

见 examples/typescript/node-cache 或者说 examples/typescript/redis-cache 更多细节.

清除缓存

如果您想要清除缓存 :

joystickClient.clearCache().then(() => console.log("Cache cleared!"));

HTTP 客户端

您可以提供自定义的 HTTP 客户端, 可用于指定自定义代理或收集 HTTP 请求的详细度量衡 .

通过执行接口更改您的 HTTP 客户端执行 Http 客户端。 。 。 .

见 src/internals/client/axios-client 更多细节.

测试

运行单位测试,只是运行:

npm test

贷项

许可证

麻省理工学院. 请看 许可证文件 更多信息.

版本与发布记录

@getjoystick/joystick-js 共发布 15 个版本,首次发布于 2023/04/06;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.3latest2023/05/083 年前
0.1.3-alpha.12023/05/053 年前
0.1.22023/04/263 年前
0.1.12023/04/253 年前
0.1.02023/04/193 年前
0.0.1-alpha.62023/04/173 年前

关于 @getjoystick/joystick-js 的常见问题

@getjoystick/joystick-js 是什么?

Javascript SDK 用于 Joystick

如何安装 @getjoystick/joystick-js?

在项目目录运行 npm install @getjoystick/joystick-js,或使用 pnpm add / yarn add / bun add。

@getjoystick/joystick-js 支持 TypeScript 吗?

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

@getjoystick/joystick-js 支持 ESM 还是 CommonJS?

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

@getjoystick/joystick-js 可以商用吗?

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

@getjoystick/joystick-js 的下载量有多少?

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

@getjoystick/joystick-js 还在维护吗?

最新版本 0.1.3 发布于 2023/05/08(3 年前);至今共发布 15 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/04/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。