docs: modify docs terms

Author: frankzhaopeng

WeChat/FPUser.ts

@@ -12,7 +12,7 @@ export class FPUser {
   }
 
   /**
-   * Add an attribute to the FPUser client.
+   * Upload attributes to the FPUser client.
    * 
    * @param attrName
    *   The attribute key.

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, FPOptions, FPStorageProvider } from "./types";
+import { FPDetail, IParams, FPConfig, FPStorageProvider } from "./types";
 
 const PKG_VERSION = "SDK_VERSION";
 const UA = "WECHAT_MINIPROGRAM/" + PKG_VERSION;
@@ -32,7 +32,7 @@ class FeatureProbe extends TinyEmitter {
   private refreshInterval: number;
   private clientSdkKey: string;
   private user: FPUser;
-  private toggles: { [key: string]: FPToggleDetail } | undefined;
+  private toggles: { [key: string]: FPDetail } | undefined;
   private timer?: NodeJS.Timeout;
   private timeoutTimer?: NodeJS.Timeout;
   private readyPromise: null | Promise<void>;
@@ -66,7 +66,7 @@ class FeatureProbe extends TinyEmitter {
     user,
     refreshInterval = 1000,
     timeoutInterval = 10000,
-  }: FPOptions) {
+  }: FPConfig) {
     if (!clientSdkKey) {
       throw new Error("clientSdkKey is required");
     }
@@ -227,7 +227,7 @@ class FeatureProbe extends TinyEmitter {
    * @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 {
+  public boolDetail(key: string, defaultValue: boolean): FPDetail {
     return this.toggleDetail(key, defaultValue, "boolean");
   }
 
@@ -240,7 +240,7 @@ class FeatureProbe extends TinyEmitter {
    * @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 {
+  public numberDetail(key: string, defaultValue: number): FPDetail {
     return this.toggleDetail(key, defaultValue, "number");
   }
 
@@ -253,7 +253,7 @@ class FeatureProbe extends TinyEmitter {
    * @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 {
+  public stringDetail(key: string, defaultValue: string): FPDetail {
     return this.toggleDetail(key, defaultValue, "string");
   }
 
@@ -266,14 +266,14 @@ class FeatureProbe extends TinyEmitter {
    * @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 {
+  public jsonDetail(key: string, defaultValue: object): FPDetail {
     return this.toggleDetail(key, defaultValue, "object");
   }
 
   /**
    * Returns an object of all available toggles' details to the current user.
    */
-  public allToggles(): { [key: string]: FPToggleDetail } | undefined {
+  public allToggles(): { [key: string]: FPDetail } | undefined {
     return Object.assign({}, this.toggles);
   }
 
@@ -342,7 +342,7 @@ class FeatureProbe extends TinyEmitter {
     key: string,
     defaultValue: any,
     valueType: string
-  ): FPToggleDetail {
+  ): FPDetail {
     this.sendEvents(key);
 
     if (this.toggles == undefined) {

WeChat/index.ts

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

WeChat/types.ts

@@ -21,19 +21,19 @@ export interface IParams {
   access: IAccess;
 }
 
-export interface FPToggleDetail {
+export interface FPDetail {
   /**
-   * Return value of a toggle for the current user.
+   * The value corresponding to the rule in the UI platform.
    */
   value: boolean | string | number | object;
 
   /**
-   * The index of the matching rule.
+   * The sequence number of the rule in the UI configuration that hit the rule.
    */
   ruleIndex: number | null;
 
   /**
-   * The index of the matching variation.
+   * The sequence number of the variation in the UI platform.
    */
   variationIndex: number | null;
 
@@ -43,14 +43,14 @@ export interface FPToggleDetail {
   version: number | null;
 
   /**
-   * The failed reason.
+   * Why return this value, like disabled, default, not exist and so on.
    */
   reason: string;
 }
 
-export interface FPOptions {
+export interface FPConfig {
   /**
-   * The unified URL to get toggles and post events.
+   * The unified URL to connect FeatureProbe Server.
    */
   remoteUrl?: string;
 
@@ -75,12 +75,12 @@ export interface FPOptions {
   user: FPUser;
 
   /**
-   * The SDK check for updated in millisecond.
+   * Milliseconds for SDK to check for update.
    */
   refreshInterval?: number;
 
   /**
-   * Timeout for SDK initialization, SDK will emit an `error` event when timeout is reaching.
+   * Milliseconds for SDK to initialize, SDK will emit an `error` event when milliseconds reach.
    */
   timeoutInterval?: number
 }

docs/assets/search.js

@@ -22,7 +22,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">FPUser</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f046492/WeChat/FPUser.ts#L5">WeChat/FPUser.ts:5</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f23cd63/WeChat/FPUser.ts#L5">WeChat/FPUser.ts:5</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -60,7 +60,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> key: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="FPUser.html" class="tsd-signature-type" data-tsd-kind="Class">FPUser</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f046492/WeChat/FPUser.ts#L9">WeChat/FPUser.ts:9</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f23cd63/WeChat/FPUser.ts#L9">WeChat/FPUser.ts:9</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="attrs" class="tsd-anchor"></a>
@@ -72,12 +72,12 @@ <h4>Type declaration</h4>
 <li class="tsd-parameter-index-signature">
 <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f046492/WeChat/FPUser.ts#L7">WeChat/FPUser.ts:7</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f23cd63/WeChat/FPUser.ts#L7">WeChat/FPUser.ts:7</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="key" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>key</span><a href="#key" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f046492/WeChat/FPUser.ts#L6">WeChat/FPUser.ts:6</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f23cd63/WeChat/FPUser.ts#L6">WeChat/FPUser.ts:6</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="extendAttrs" class="tsd-anchor"></a>
@@ -99,7 +99,7 @@ <h5>attrs: <span class="tsd-signature-symbol">{ </span><br/><span>    </span
 <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="FPUser.html" class="tsd-signature-type" data-tsd-kind="Class">FPUser</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f046492/WeChat/FPUser.ts#L53">WeChat/FPUser.ts:53</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f23cd63/WeChat/FPUser.ts#L53">WeChat/FPUser.ts:53</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="get" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -116,7 +116,7 @@ <h5>attrName: <span class="tsd-signature-type">string</span></h5>
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f046492/WeChat/FPUser.ts#L67">WeChat/FPUser.ts:67</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f23cd63/WeChat/FPUser.ts#L67">WeChat/FPUser.ts:67</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAttrs" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>get<wbr/>Attrs</span><a href="#getAttrs" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -129,7 +129,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </spa
 <li class="tsd-parameter-index-signature">
 <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f046492/WeChat/FPUser.ts#L42">WeChat/FPUser.ts:42</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f23cd63/WeChat/FPUser.ts#L42">WeChat/FPUser.ts:42</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getKey" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>get<wbr/>Key</span><a href="#getKey" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -139,7 +139,7 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Key</span><a href="#getKey" aria-labe
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f046492/WeChat/FPUser.ts#L31">WeChat/FPUser.ts:31</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f23cd63/WeChat/FPUser.ts#L31">WeChat/FPUser.ts:31</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stableRollout" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>stable<wbr/>Rollout</span><a href="#stableRollout" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -156,13 +156,13 @@ <h5>key: <span class="tsd-signature-type">string</span></h5>
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="FPUser.html" class="tsd-signature-type" data-tsd-kind="Class">FPUser</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f046492/WeChat/FPUser.ts#L78">WeChat/FPUser.ts:78</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f23cd63/WeChat/FPUser.ts#L78">WeChat/FPUser.ts:78</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="with" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>with</span><a href="#with" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
 <li class="tsd-signature tsd-anchor-link" id="with.with-1">with<span class="tsd-signature-symbol">(</span>attrName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attrValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FPUser.html" class="tsd-signature-type" data-tsd-kind="Class">FPUser</a><a href="#with.with-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Add an attribute to the FPUser client.</p>
+<div class="tsd-comment tsd-typography"><p>Upload attributes to the FPUser client.</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
@@ -177,7 +177,7 @@ <h5>attrValue: <span class="tsd-signature-type">string</span></h5>
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="FPUser.html" class="tsd-signature-type" data-tsd-kind="Class">FPUser</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f046492/WeChat/FPUser.ts#L23">WeChat/FPUser.ts:23</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/FeatureProbe/client-sdk-miniprogram/blob/f23cd63/WeChat/FPUser.ts#L23">WeChat/FPUser.ts:23</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">