Javascript 客户端 Joystick 远程配置
用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
贷项
许可证
麻省理工学院. 请看 许可证文件 更多信息.