docs: update documentation

Author: frankzhaopeng

WeChat/FPUser.ts

@@ -1,3 +1,7 @@
+/**
+ * You can obtainan a client of FPUser, 
+ * which provides all of the FPUser's functionality.
+ */
 export class FPUser {
   private key: string;
   private attrs: { [key: string]: string };
@@ -7,30 +11,70 @@ export class FPUser {
     this.attrs = {};
   }
 
+  /**
+   * Add an attribute to the FPUser client.
+   * 
+   * @param attrName
+   *   The attribute key.
+   * @param attrValue
+   *   The attribute value.
+   * 
+   */
   public with(attrName: string, attrValue: string): FPUser {
     this.attrs[attrName] = attrValue;
     return this;
   }
 
+  /**
+   * Get the unique key of the FPUser client.
+   */
   public getKey(): string {
     return this.key;
   }
 
+  /**
+   * Get all attributes of the FPUser client.
+   * 
+   * @param key
+   *   The uqique FPUser key.
+   * 
+   */
   public getAttrs(): { [key: string]: string } {
     return Object.assign({}, this.attrs);
   }
 
+  /**
+   * Extend several attributes of the FPUser client.
+   * 
+   * @param attrs
+   *   key-value pairs.
+   * 
+   */
   public extendAttrs(attrs: { [key: string]: string }): FPUser {
     for (const key in attrs) {
       this.attrs[key] = attrs[key];
     }
     return this;
   }
 
+  /**
+   * Get attribute value of a specified attribute key.
+   * 
+   * @param attrName
+   *   The attribute key.
+   * 
+   */
   public get(attrName: string): string | undefined {
     return this.attrs[attrName];
   }
 
+  /**
+   * Change a stable key for the FPUser client.
+   * 
+   * @param key
+   *   The uqique FPUser key.
+   * 
+   */
   public stableRollout(key: string): FPUser {
     this.key = key;
     return this;

WeChat/FeatureProbe.ts

@@ -3,7 +3,7 @@ import { Base64 } from "js-base64";
 import wefetch from "wefetch";
 import { FPUser } from "./FPUser";
 import StorageProvider from "./localstorage";
-import { FPToggleDetail, IParams, IOption, IStorageProvider } from "./types";
+import { FPToggleDetail, IParams, FPOptions, FPStorageProvider } from "./types";
 
 const PKG_VERSION = "SDK_VERSION";
 const UA = "WECHAT_MINIPROGRAM/" + PKG_VERSION;
@@ -22,6 +22,10 @@ const EVENTS = {
   CACHE_READY: "cache_ready"
 };
 
+/**
+ * You can obtainan a client of FeatureProbe, 
+ * which provides access to all of the SDK's functionality.
+ */
 class FeatureProbe extends TinyEmitter {
   private togglesUrl: string ;
   private eventsUrl: string;
@@ -33,7 +37,7 @@ class FeatureProbe extends TinyEmitter {
   private timeoutTimer?: NodeJS.Timeout;
   private readyPromise: null | Promise<void>;
   private status: string;
-  private storage: IStorageProvider;
+  private storage: FPStorageProvider;
   private timeoutInterval: number;
 
   constructor() {
@@ -51,6 +55,9 @@ class FeatureProbe extends TinyEmitter {
     this.readyPromise = null;
   }
 
+  /**
+   * Initialize the FeatureProbe client.
+   */
   public init({
     remoteUrl,
     togglesUrl,
@@ -59,7 +66,7 @@ class FeatureProbe extends TinyEmitter {
     user,
     refreshInterval = 1000,
     timeoutInterval = 10000,
-  }: IOption) {
+  }: FPOptions) {
     if (!clientSdkKey) {
       throw new Error("clientSdkKey is required");
     }
@@ -87,6 +94,9 @@ class FeatureProbe extends TinyEmitter {
     this.timeoutInterval = timeoutInterval;
   }
 
+  /**
+   * Start the FeatureProbe client.
+   */
   public async start() {
     this.timeoutTimer = setTimeout(() => {
       if (this.status === STATUS.PENDING) {
@@ -108,13 +118,23 @@ class FeatureProbe extends TinyEmitter {
     }
   }
 
+  /**
+   * Stop the FeatureProbe client, once the client has been stopped, 
+   * SDK will no longer listen for toggle changes or send metrics to Server.
+   */
   public stop() {
     clearInterval(this.timer);
     clearTimeout(this.timeoutTimer);
     this.timeoutTimer = undefined;
     this.timer = undefined;
   }
 
+  /**
+   * Returns a Promise which tracks the client's ready state.
+   *
+   * The Promise will be resolved if the client successfully get toggles from the server
+   * or ejected if client error get toggles from the server until `timeoutInterval` countdown reaches.
+   */
   public waitUntilReady(): Promise<void> {
     if (this.readyPromise) {
       return this.readyPromise;
@@ -146,50 +166,140 @@ class FeatureProbe extends TinyEmitter {
     return this.readyPromise;
   }
 
+  /**
+   * Determines the return `boolean` value of a toggle for the current user.
+   *
+   *
+   * @param key
+   *   The unique key of the toggle.
+   * @param defaultValue
+   *   The default value of the toggle, to be used if the value is not available from FeatureProbe.
+   */
   public boolValue(key: string, defaultValue: boolean): boolean {
     return this.toggleValue(key, defaultValue, "boolean");
   }
 
+  /**
+   * Determines the return `number` value of a toggle for the current user.
+   *
+   *
+   * @param key
+   *   The unique key of the toggle.
+   * @param defaultValue
+   *   The default value of the toggle, to be used if the value is not available from FeatureProbe.
+   */
   public numberValue(key: string, defaultValue: number): number {
     return this.toggleValue(key, defaultValue, "number");
   }
 
+  /**
+   * Determines the return `string` value of a toggle for the current user.
+   *
+   *
+   * @param key
+   *   The unique key of the toggle.
+   * @param defaultValue
+   *   The default value of the toggle, to be used if the value is not available from FeatureProbe.
+   */
   public stringValue(key: string, defaultValue: string): string {
     return this.toggleValue(key, defaultValue, "string");
   }
 
+  /**
+   * Determines the return `json` value of a toggle for the current user.
+   *
+   *
+   * @param key
+   *   The unique key of the toggle.
+   * @param defaultValue
+   *   The default value of the toggle, to be used if the value is not available from FeatureProbe.
+   */
   public jsonValue(key: string, defaultValue: object): object {
     return this.toggleValue(key, defaultValue, "object");
   }
 
+  /**
+   * Determines the return `boolean` value of a toggle for the current user, along with information about how it was calculated.
+   *
+   *
+   * @param key
+   *   The unique key of the toggle.
+   * @param defaultValue
+   *   The default value of the toggle, to be used if the value is not available from FeatureProbe.
+   */
   public boolDetail(key: string, defaultValue: boolean): FPToggleDetail {
     return this.toggleDetail(key, defaultValue, "boolean");
   }
 
+  /**
+   * Determines the return `number` value of a toggle for the current user, along with information about how it was calculated.
+   *
+   *
+   * @param key
+   *   The unique key of the toggle.
+   * @param defaultValue
+   *   The default value of the toggle, to be used if the value is not available from FeatureProbe.
+   */
   public numberDetail(key: string, defaultValue: number): FPToggleDetail {
     return this.toggleDetail(key, defaultValue, "number");
   }
 
+  /**
+   * Determines the return `string` value of a toggle for the current user, along with information about how it was calculated.
+   *
+   *
+   * @param key
+   *   The unique key of the toggle.
+   * @param defaultValue
+   *   The default value of the toggle, to be used if the value is not available from FeatureProbe.
+   */
   public stringDetail(key: string, defaultValue: string): FPToggleDetail {
     return this.toggleDetail(key, defaultValue, "string");
   }
 
+  /**
+   * Determines the return `json` value of a toggle for the current user, along with information about how it was calculated.
+   *
+   *
+   * @param key
+   *   The unique key of the toggle.
+   * @param defaultValue
+   *   The default value of the toggle, to be used if the value is not available from FeatureProbe.
+   */
   public jsonDetail(key: string, defaultValue: object): FPToggleDetail {
     return this.toggleDetail(key, defaultValue, "object");
   }
 
+  /**
+   * Returns an object of all available toggles' details to the current user.
+   */
   public allToggles(): { [key: string]: FPToggleDetail } | undefined {
     return Object.assign({}, this.toggles);
   }
 
+  /**
+   * Returns the current user.
+   *
+   * This is the user that was most recently passed to [[identifyUser]], or, if [[identifyUser]] has never
+   * been called, the initial user specified when the client was created.
+   */
   public getUser(): FPUser {
     return this.user;
   }
 
+  /**
+   * Changing the current user to FeatureProbe.
+   *
+   * @param user
+   *   A new FPUser instance.
+   */
   public identifyUser(user: FPUser) {
     this.user = user;
   }
 
+  /**
+   * Logout the current user, change the current user to an anonymous user.
+   */
   public logout() {
     const user = new FPUser();
     this.identifyUser(user);
@@ -380,6 +490,9 @@ class FeatureProbe extends TinyEmitter {
   }
 }
 
+/**
+ * The client of the FeatureProbe.
+ */
 const featureProbeClient = new FeatureProbe();
 
 export { FeatureProbe, featureProbeClient };

WeChat/index.ts

@@ -1,7 +1,8 @@
 import { FPUser } from "./FPUser";
 import { featureProbeClient, FeatureProbe } from "./FeatureProbe";
+import { FPToggleDetail, FPStorageProvider, FPOptions } from "./types";
 
-export { FPUser, FeatureProbe, featureProbeClient };
+export { FPUser, FeatureProbe, featureProbeClient, FPToggleDetail, FPStorageProvider, FPOptions };
 
 declare global {
   let App: (config?: any) => any;