Interface FPConfig

Hierarchy

  • FPConfig

Properties

clientSdkKey enableAutoReporting? enableRealtime? eventsUrl? realtimePath? realtimeUrl? refreshInterval? remoteUrl? timeoutInterval? togglesUrl? user

Properties

clientSdkKey

clientSdkKey: string

The Client SDK Key is used to authentification.

Optional enableAutoReporting

enableAutoReporting?: boolean

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

Optional enableRealtime

enableRealtime?: boolean

Whether SDK should use WebSocket. Default value is false.

Optional eventsUrl

eventsUrl?: string

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

Optional realtimePath

realtimePath?: string

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

Optional realtimeUrl

realtimeUrl?: string

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

Optional refreshInterval

refreshInterval?: number

Milliseconds for SDK to check for update.

Optional remoteUrl

remoteUrl?: string

The unified URL to connect FeatureProbe Server.

Optional timeoutInterval

timeoutInterval?: number

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

Optional togglesUrl

togglesUrl?: string

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

user

user: FPUser

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

Settings

Member Visibility

Theme

Generated using TypeDoc