@ flaggly/ sdk (英语)

客户端 SDK 为 旗帜 - 在Cloudflare Workers上自办的地标旗服务.

安装

pnpm i @flaggly/sdk

设置

定义您的旗帜图案并创建客户端 :

import { Flaggly } from '@flaggly/sdk';

type Flags = {
  'dark-mode': { type: 'boolean' };
  'banner': { type: 'payload'; result: { text: string; color: string } };
  'checkout': { type: 'variant'; result: string };
};

const flaggly = new Flaggly<Flags>({
  url: 'https://flaggly.example.workers.dev',
  apiKey: 'YOUR_USER_JWT',
});

国旗在创建时立即进行评估. 过 lazy: true 等待直到你打电话 identify() 或者说 fetchFlags()。 。 。 .

使用量

// Type-safe getters
const isDarkMode = flaggly.getBooleanFlag('dark-mode');
const banner = flaggly.getPayloadFlag('banner');
const checkout = flaggly.getVariantFlag('checkout');

识别用户

打电话 identify() 当用户登录时。 重新评价所有旗子的用户背景 :

await flaggly.identify(userId, { email: user.email, tier: user.tier });

反应

import { Flaggly, FlagValue } from '@flaggly/sdk';
import { useSyncExternalStore } from 'react';

const flaggly = new Flaggly<Flags>({
  url: 'https://flaggly.example.workers.dev',
  apiKey: 'YOUR_USER_JWT',
  lazy: true,
  bootstrap: {
    'dark-mode': false,
  },
});

export const useFlags = () =>
  useSyncExternalStore(flaggly.store.subscribe, flaggly.store.get, flaggly.store.get);

export const useFlag = <K extends keyof Flags>(key: K): FlagValue<Flags[K]> => {
  const data = useFlags();
  return data?.[key].result as FlagValue<Flags[K]>;
};

Cloudflare工人(服务约束)

const flaggly = new Flaggly<Flags>({
  url: 'https://flaggly.example.workers.dev',
  apiKey: 'YOUR_USER_JWT',
  lazy: true,
  workerFetch: (url, init) => env.FLAGGLY_SERVICE.fetch(url, init),
});

选项

文档

页:1 (原始内容存档于2017-06-21). glagly.dev。 。 。 .

许可证

麻省理工学院