diff --git a/docs/classes/FPUser.html b/docs/classes/FPUser.html index 77b7784..c2e1cc6 100644 --- a/docs/classes/FPUser.html +++ b/docs/classes/FPUser.html @@ -1,16 +1,16 @@ -FPUser | FeatureProbe Client Side SDK for JavaScript (2.0.2)
+FPUser | FeatureProbe Client Side SDK for JavaScript (2.0.3)
+
  • The search index is not available
    • FeatureProbe Client Side SDK for JavaScript (2.0.3)

    Class FPUser

    @@ -22,7 +22,7 @@

    Hierarchy

    • FPUser
    +
  • Defined in src/FPUser.ts:5
    • @@ -60,7 +60,7 @@

    Parameters

    Optional key: string

    Returns FPUser

    +
  • Defined in src/FPUser.ts:9

    • Properties

    @@ -72,12 +72,12 @@

    Type declaration

  • [key: string]: string
    • +
  • Defined in src/FPUser.ts:7

    • Private key

    key: string
    +
  • Defined in src/FPUser.ts:6

    • Methods

    @@ -99,7 +99,7 @@
    attrs: { [key: [key: string]: string

    Returns FPUser

    +
  • Defined in src/FPUser.ts:53

    • get

    Returns undefined | string

    +
  • Defined in src/FPUser.ts:67

    • getAttrs

    +
  • Defined in src/FPUser.ts:42

    • getKey

    +
  • Defined in src/FPUser.ts:31

    • stableRollout

    Returns FPUser

    +
  • Defined in src/FPUser.ts:78

    • with

    Returns FPUser

    +
  • Defined in src/FPUser.ts:23
    • @@ -197,7 +197,7 @@

    Theme

    FeatureProbe Client Side SDK for JavaScript (2.0.2)
    +
  • The search index is not available
    • FeatureProbe Client Side SDK for JavaScript (2.0.3)

    Class FeatureProbe

    @@ -24,7 +24,7 @@

    Hierarchy

    • FeatureProbe
    +
  • Defined in src/FeatureProbe.ts:35
    • @@ -100,94 +100,94 @@
    __namedParameters: Returns FeatureProbe
    +
  • Defined in src/FeatureProbe.ts:54

    • Properties

    Private clientSdkKey

    clientSdkKey: string
    +
  • Defined in src/FeatureProbe.ts:42

    • Private Optional eventRecorder

    eventRecorder?: EventRecorder
    +
  • Defined in src/FeatureProbe.ts:52

    • Private eventsUrl

    eventsUrl: string
    +
  • Defined in src/FeatureProbe.ts:37

    • Private getEventsUrl

    getEventsUrl: string
    +
  • Defined in src/FeatureProbe.ts:38

    • Private readyPromise

    readyPromise: null | Promise<void>
    +
  • Defined in src/FeatureProbe.ts:47

    • Private realtimePath

    realtimePath: string
    +
  • Defined in src/FeatureProbe.ts:40

    • Private realtimeUrl

    realtimeUrl: string
    +
  • Defined in src/FeatureProbe.ts:39

    • Private refreshInterval

    refreshInterval: number
    +
  • Defined in src/FeatureProbe.ts:41

    • Private Optional socket

    socket?: Socket<DefaultEventsMap, DefaultEventsMap>
    +
  • Defined in src/FeatureProbe.ts:51

    • Private status

    status: string
    +
  • Defined in src/FeatureProbe.ts:48

    • Private storage

    storage: FPStorageProvider
    +
  • Defined in src/FeatureProbe.ts:50

    • Private timeoutInterval

    timeoutInterval: number
    +
  • Defined in src/FeatureProbe.ts:49

    • Private Optional timeoutTimer

    timeoutTimer?: Timer
    +
  • Defined in src/FeatureProbe.ts:46

    • Private Optional timer

    timer?: Timer
    +
  • Defined in src/FeatureProbe.ts:45

    • Private toggles

    toggles: undefined | { [key: string]: FPDetail }
    +
  • Defined in src/FeatureProbe.ts:44

    • Private togglesUrl

    togglesUrl: string
    +
  • Defined in src/FeatureProbe.ts:36

    • Private user

    user: FPUser
    +
  • Defined in src/FeatureProbe.ts:43

    • Methods

    @@ -199,7 +199,7 @@

    allToggles

    Returns undefined | { [key: string]: FPDetail }

    +
  • Defined in src/FeatureProbe.ts:318

    • boolDetail

      @@ -220,7 +220,7 @@
      defaultValue: boolean

    Returns FPDetail

    +
  • Defined in src/FeatureProbe.ts:272

    • boolValue

    Returns boolean

    +
  • Defined in src/FeatureProbe.ts:220

    • Private connectSocket

    +
  • Defined in src/FeatureProbe.ts:372

    • emit

    +
  • Defined in src/FeatureProbe.ts:539

    • Private fetchToggles

    +
  • Defined in src/FeatureProbe.ts:497

    • flush

    +
  • Defined in src/FeatureProbe.ts:355

    • getUser

    +
  • Defined in src/FeatureProbe.ts:328

    • identifyUser

    Returns void

    +
  • Defined in src/FeatureProbe.ts:338

    • jsonDetail

    +
  • Defined in src/FeatureProbe.ts:311

    • jsonValue

    +
  • Defined in src/FeatureProbe.ts:259

    • logout

    +
  • Defined in src/FeatureProbe.ts:347

    • numberDetail

    Returns FPDetail

    +
  • Defined in src/FeatureProbe.ts:285

    • numberValue

    Returns number

    +
  • Defined in src/FeatureProbe.ts:233

    • off

    +
  • Defined in src/FeatureProbe.ts:134

    • stop

    +
  • Defined in src/FeatureProbe.ts:167

    • stringDetail

    Returns FPDetail

    +
  • Defined in src/FeatureProbe.ts:298

    • stringValue

    Returns string

    +
  • Defined in src/FeatureProbe.ts:246

    • Private successInitialized

    +
  • Defined in src/FeatureProbe.ts:526

    • Private toggleDetail

    Returns FPDetail

    +
  • Defined in src/FeatureProbe.ts:436

    • Private toggleValue

    Returns IReturnValue

    +
  • Defined in src/FeatureProbe.ts:391

    • track

    Returns void

    +
  • Defined in src/FeatureProbe.ts:362

    • waitUntilReady

    +
  • Defined in src/FeatureProbe.ts:180

    • Static newForTest

    Returns FeatureProbe

    +
  • Defined in src/FeatureProbe.ts:108
    • @@ -638,7 +636,7 @@

    Theme

    FeatureProbe Client Side SDK for JavaScript (2.0.2)
    +
  • The search index is not available
    • FeatureProbe Client Side SDK for JavaScript (2.0.3)

    Function initializePlatform

    @@ -28,7 +28,7 @@
    options:

    Returns void

    +
  • Defined in src/index.ts:12
    • @@ -48,7 +48,7 @@

    Theme

    FeatureProbe Client Side SDK for JavaScript (2.0.2)
    +
  • The search index is not available
    • FeatureProbe Client Side SDK for JavaScript (2.0.3)
    -

    FeatureProbe Client Side SDK for JavaScript (2.0.2)

    +

    FeatureProbe Client Side SDK for JavaScript (2.0.3)

    Index

    @@ -54,7 +54,7 @@

    Theme

    FeatureProbe Client Side SDK for JavaScript (2.0.2) +
  • The search index is not available
    • FeatureProbe Client Side SDK for JavaScript (2.0.3)

    Interface FPConfig

    @@ -18,7 +18,7 @@

    Hierarchy

    • FPConfig
    +
  • Defined in src/types.ts:64
    • @@ -45,70 +45,70 @@

    clientSdkKey

    The Client SDK Key is used to authentification.

    +
  • Defined in src/types.ts:93

    • Optional enableAutoReporting

    enableAutoReporting?: boolean

    Whether SDK should report pageview and click event automatically. Default value is true.

    +
  • Defined in src/types.ts:113

    • Optional eventsUrl

    eventsUrl?: string

    The specific URL to post events, if not set, will generate from remoteUrl.

    +
  • Defined in src/types.ts:78

    • Optional realtimePath

    realtimePath?: string

    The specific path to receive realtime events, if not set, default value will be used.

    +
  • Defined in src/types.ts:88

    • Optional realtimeUrl

    realtimeUrl?: string

    The specific URL to receive realtime events, if not set, will generate from remoteUrl.

    +
  • Defined in src/types.ts:83

    • Optional refreshInterval

    refreshInterval?: number

    Milliseconds for SDK to check for update.

    +
  • Defined in src/types.ts:103

    • Optional remoteUrl

    remoteUrl?: string

    The unified URL to connect FeatureProbe Server.

    +
  • Defined in src/types.ts:68

    • Optional timeoutInterval

    timeoutInterval?: number

    Milliseconds for SDK to initialize, SDK will emit an error event when milliseconds reach.

    +
  • Defined in src/types.ts:108

    • Optional togglesUrl

    togglesUrl?: string

    The specific URL to get toggles, if not set, will generate from remoteUrl.

    +
  • Defined in src/types.ts:73

    • user

    user: FPUser

    The User with attributes like name, age is used when toggle evaluation.

    +
  • Defined in src/types.ts:98
    • @@ -128,7 +128,7 @@

    Theme

    FeatureProbe Client Side SDK for JavaScript (2.0.2)
    +
  • The search index is not available
    • FeatureProbe Client Side SDK for JavaScript (2.0.3)

    Interface FPDetail

    @@ -18,7 +18,7 @@

    Hierarchy

    • FPDetail
    +
  • Defined in src/types.ts:27
    • @@ -42,49 +42,49 @@

    Optional

    Toggle last modified timestamp

    +
  • Defined in src/types.ts:61

    • reason

    reason: string

    Why return this value, like disabled, default, not exist and so on.

    +
  • Defined in src/types.ts:51

    • ruleIndex

    ruleIndex: null | number

    The sequence number of the rule in the UI configuration that hit the rule.

    +
  • Defined in src/types.ts:36

    • Optional trackAccessEvents

    trackAccessEvents?: boolean

    Whether to report access events.

    +
  • Defined in src/types.ts:56

    • value

    value: string | number | boolean | Record<string, unknown>

    The value corresponding to the rule in the UI platform.

    +
  • Defined in src/types.ts:31

    • variationIndex

    variationIndex: null | number

    The sequence number of the variation in the UI platform.

    +
  • Defined in src/types.ts:41

    • version

    version: null | number

    The version of the toggle.

    +
  • Defined in src/types.ts:46
    • @@ -104,7 +104,7 @@

    Theme

    FeatureProbe Client Side SDK for JavaScript (2.0.2)
    +
  • The search index is not available
    • FeatureProbe Client Side SDK for JavaScript (2.0.3)

    Interface FPStorageProvider

    @@ -18,7 +18,7 @@

    Hierarchy

    • FPStorageProvider
    +
  • Defined in src/types.ts:116
    • @@ -52,7 +52,7 @@
    key: string

    Returns Promise<string>

    +
  • Defined in src/types.ts:134

    • setItem

    setItem: ((key: string, data: string) => Promise<void>)
    @@ -78,7 +78,7 @@
    data: string

    Returns Promise<void>

    +
  • Defined in src/types.ts:126
    • @@ -98,7 +98,7 @@

    Theme

    FeatureProbe Client Side SDK for JavaScript (2.0.2)
    +
  • The search index is not available
    • FeatureProbe Client Side SDK for JavaScript (2.0.3)

    Interface IHttpRequest

    @@ -18,7 +18,7 @@

    Hierarchy

    • IHttpRequest
    +
  • Defined in src/types.ts:137
    • @@ -78,7 +78,7 @@
    e: string

    Returns void

    Returns void

    +
  • Defined in src/types.ts:138

    • post

    post: ((url: string, headers: Record<string, string>, data: string, successCb: (() => void), errorCb: ((e: string) => void)) => void)
    @@ -121,7 +121,7 @@
    e: string

    Returns void

    Returns void

    +
  • Defined in src/types.ts:145
    • @@ -141,7 +141,7 @@

    Theme

    FeatureProbe Client Side SDK for JavaScript (2.0.2)
    +
  • The search index is not available
    • FeatureProbe Client Side SDK for JavaScript (2.0.3)

    Interface IOption

    @@ -18,7 +18,7 @@

    Hierarchy

    • IOption
    +
  • Defined in src/types.ts:160
    • @@ -34,7 +34,7 @@

    Properties

    platform

    platform: IPlatForm
    +
  • Defined in src/types.ts:161
    • @@ -54,7 +54,7 @@

    Theme

    FeatureProbe Client Side SDK for JavaScript (2.0.2)
    +
  • The search index is not available
    • FeatureProbe Client Side SDK for JavaScript (2.0.3)

    Interface IPlatForm

    @@ -18,7 +18,7 @@

    Hierarchy

    • IPlatForm
    +
  • Defined in src/types.ts:154
    • @@ -36,17 +36,17 @@

    Properties

    UA

    UA: string
    +
  • Defined in src/types.ts:156

    • httpRequest

    httpRequest: IHttpRequest
    +
  • Defined in src/types.ts:157

    • localStorage

    localStorage: FPStorageProvider
    +
  • Defined in src/types.ts:155
    • @@ -66,7 +66,7 @@

    Theme

    FeatureProbe Client Side SDK for JavaScript (2.0.2)
    +
  • The search index is not available
    • FeatureProbe Client Side SDK for JavaScript (2.0.3)

    Type alias IReturnValue

    IReturnValue: string | number | boolean | Record<string, unknown>
    +
  • Defined in src/types.ts:25
    • @@ -35,7 +35,7 @@

    Theme