Class FeatureProbe

You can obtainan a client of FeatureProbe, which provides access to all of the SDK's functionality.

Hierarchy

TinyEmitter
- FeatureProbe

Constructors

constructor

new FeatureProbe(__namedParameters: FPConfig): FeatureProbe
Parameters
- __namedParameters: FPConfig
Returns FeatureProbe
Overrides TinyEmitter.constructor
- Defined in src/FeatureProbe.ts:54

Properties

`Private` _clientSdkKey

_clientSdkKey: string

`Private` _enableRealtime

_enableRealtime: boolean

`Private` _eventRecorder

_eventRecorder: EventRecorder

`Private` _eventsUrl

_eventsUrl: string

`Private` _getEventsUrl

_getEventsUrl: string

`Private` _readyPromise

_readyPromise: null | Promise<void>

`Private` _realtimePath

_realtimePath: string

`Private` _realtimeUrl

_realtimeUrl: string

`Private` _refreshInterval

_refreshInterval: number

`Private` _status

_status: string

`Private` _storage

_storage: FPStorageProvider

`Private` _timeoutInterval

_timeoutInterval: number

`Private` `Optional` _timeoutTimer

_timeoutTimer?: Timer

`Private` `Optional` _timer

_timer?: Timer

`Private` _toggles

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

`Private` _togglesUrl

_togglesUrl: string

`Private` _user

_user: FPUser

Accessors

clientSdkKey

get clientSdkKey(): string
Returns string
- Defined in src/FeatureProbe.ts:112

eventRecorder

get eventRecorder(): EventRecorder
Returns EventRecorder
- Defined in src/FeatureProbe.ts:124

eventsUrl

get eventsUrl(): string
Returns string
- Defined in src/FeatureProbe.ts:120

user

get user(): FPUser
Returns FPUser
- Defined in src/FeatureProbe.ts:116

Methods

allToggles

allToggles(): undefined | { [key: string]: FPDetail }
Returns an object of all available toggles' details to the current user.

Returns undefined | { [key: string]: FPDetail }
- Defined in src/FeatureProbe.ts:340

boolDetail

boolDetail(key: string, defaultValue: boolean): FPDetail
Determines the return boolean value of a toggle for the current user, along with information about how it was calculated.
Parameters
- key: string
  
  The unique key of the toggle.
- defaultValue: boolean
  
  The default value of the toggle, to be used if the value is not available from FeatureProbe.
Returns FPDetail
- Defined in src/FeatureProbe.ts:294

boolValue

boolValue(key: string, defaultValue: boolean): boolean
Determines the return boolean value of a toggle for the current user.
Parameters
- key: string
  
  The unique key of the toggle.
- defaultValue: boolean
  
  The default value of the toggle, to be used if the value is not available from FeatureProbe.
Returns boolean
- Defined in src/FeatureProbe.ts:242

`Private` connectSocket

connectSocket(): void
Returns void
- Defined in src/FeatureProbe.ts:394

emit

emit(event: string, ...args: any[]): FeatureProbe
Parameters
- event: string
- Rest ...args: any[]
Returns FeatureProbe
Inherited from TinyEmitter.emit
- Defined in node_modules/tiny-emitter/index.d.ts:4

`Private` errorInitialized

errorInitialized(): void
Returns void
- Defined in src/FeatureProbe.ts:589

`Private` fetchToggles

fetchToggles(): Promise<void>
Returns Promise<void>
- Defined in src/FeatureProbe.ts:545

flush

flush(): void
Manually push events.

Returns void
- Defined in src/FeatureProbe.ts:377

getUser

getUser(): FPUser
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.

Returns FPUser
- Defined in src/FeatureProbe.ts:350

identifyUser

identifyUser(user: FPUser): void
Changing the current user to FeatureProbe.
Parameters
- user: FPUser
  
  A new FPUser instance.
Returns void
- Defined in src/FeatureProbe.ts:360

jsonDetail

jsonDetail(key: string, defaultValue: Record<string, unknown>): FPDetail
Determines the return json value of a toggle for the current user, along with information about how it was calculated.
Parameters
- key: string
  
  The unique key of the toggle.
- defaultValue: Record<string, unknown>
  
  The default value of the toggle, to be used if the value is not available from FeatureProbe.
Returns FPDetail
- Defined in src/FeatureProbe.ts:333

jsonValue

jsonValue(key: string, defaultValue: Record<string, unknown>): Record<string, unknown>
Determines the return json value of a toggle for the current user.
Parameters
- key: string
  
  The unique key of the toggle.
- defaultValue: Record<string, unknown>
  
  The default value of the toggle, to be used if the value is not available from FeatureProbe.
Returns Record<string, unknown>
- Defined in src/FeatureProbe.ts:281

logout

logout(): void
Logout the current user, change the current user to an anonymous user.

Returns void
- Defined in src/FeatureProbe.ts:369

numberDetail

numberDetail(key: string, defaultValue: number): FPDetail
Determines the return number value of a toggle for the current user, along with information about how it was calculated.
Parameters
- key: string
  
  The unique key of the toggle.
- defaultValue: number
  
  The default value of the toggle, to be used if the value is not available from FeatureProbe.
Returns FPDetail
- Defined in src/FeatureProbe.ts:307

numberValue

numberValue(key: string, defaultValue: number): number
Determines the return number value of a toggle for the current user.
Parameters
- key: string
  
  The unique key of the toggle.
- defaultValue: number
  
  The default value of the toggle, to be used if the value is not available from FeatureProbe.
Returns number
- Defined in src/FeatureProbe.ts:255

off

off(event: string, callback?: Function): FeatureProbe
Parameters
- event: string
- Optional callback: Function
Returns FeatureProbe
Inherited from TinyEmitter.off
- Defined in node_modules/tiny-emitter/index.d.ts:5

on

on(event: string, callback: Function, ctx?: any): FeatureProbe
Parameters
- event: string
- callback: Function
- Optional ctx: any
Returns FeatureProbe
Inherited from TinyEmitter.on
- Defined in node_modules/tiny-emitter/index.d.ts:2

once

once(event: string, callback: Function, ctx?: any): FeatureProbe
Parameters
- event: string
- callback: Function
- Optional ctx: any
Returns FeatureProbe
Inherited from TinyEmitter.once
- Defined in node_modules/tiny-emitter/index.d.ts:3

start

start(): Promise<void>
Start the FeatureProbe client.

Returns Promise<void>
- Defined in src/FeatureProbe.ts:154

stop

stop(): void
Stop the FeatureProbe client, once the client has been stopped, SDK will no longer listen for toggle changes or send metrics to Server.

Returns void
- Defined in src/FeatureProbe.ts:189

stringDetail

stringDetail(key: string, defaultValue: string): FPDetail
Determines the return string value of a toggle for the current user, along with information about how it was calculated.
Parameters
- key: string
  
  The unique key of the toggle.
- defaultValue: string
  
  The default value of the toggle, to be used if the value is not available from FeatureProbe.
Returns FPDetail
- Defined in src/FeatureProbe.ts:320

stringValue

stringValue(key: string, defaultValue: string): string
Determines the return string value of a toggle for the current user.
Parameters
- key: string
  
  The unique key of the toggle.
- defaultValue: string
  
  The default value of the toggle, to be used if the value is not available from FeatureProbe.
Returns string
- Defined in src/FeatureProbe.ts:268

`Private` successInitialized

successInitialized(): void
Returns void
- Defined in src/FeatureProbe.ts:576

`Private` toggleDetail

toggleDetail(key: string, defaultValue: IReturnValue, valueType: string): FPDetail
Parameters
- key: string
- defaultValue: IReturnValue
- valueType: string
Returns FPDetail
- Defined in src/FeatureProbe.ts:470

`Private` toggleValue

toggleValue(key: string, defaultValue: IReturnValue, valueType: string): IReturnValue
Parameters
- key: string
- defaultValue: IReturnValue
- valueType: string
Returns IReturnValue
- Defined in src/FeatureProbe.ts:411

track

track(name: string, value?: unknown): void
Record custom events, value is optional.
Parameters
- name: string
- Optional value: unknown
Returns void
- Defined in src/FeatureProbe.ts:384

waitUntilReady

waitUntilReady(): Promise<void>
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.

Returns Promise<void>
- Defined in src/FeatureProbe.ts:202

`Static` newForTest

newForTest(toggles: { [key: string]: boolean }): FeatureProbe
Parameters
- toggles: { [key: string]: boolean }
  - [key: string]: boolean
Returns FeatureProbe
- Defined in src/FeatureProbe.ts:128

Class FeatureProbe

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: FPConfig

Returns FeatureProbe

Properties

Private _clientSdkKey

Private _enableRealtime

Private _eventRecorder

Private _eventsUrl

Private _getEventsUrl

Private _readyPromise

Private _realtimePath

Private _realtimeUrl

Private _refreshInterval

Private _status

Private _storage

Private _timeoutInterval

Private Optional _timeoutTimer

Private Optional _timer

Private _toggles

Private _togglesUrl

Private _user

Accessors

clientSdkKey

Returns string

eventRecorder

Returns EventRecorder

eventsUrl

Returns string

user

Returns FPUser

Methods

allToggles

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

boolDetail

Parameters

key: string

defaultValue: boolean

Returns FPDetail

boolValue

Parameters

key: string

defaultValue: boolean

Returns boolean

Private connectSocket

Returns void

emit

Parameters

event: string

Rest ...args: any[]

Returns FeatureProbe

Private errorInitialized

Returns void

Private fetchToggles

Returns Promise<void>

flush

Returns void

getUser

Returns FPUser

identifyUser

Parameters

user: FPUser

Returns void

jsonDetail

Parameters

key: string

defaultValue: Record<string, unknown>

Returns FPDetail

jsonValue

Parameters

key: string

defaultValue: Record<string, unknown>

`Private` _clientSdkKey

`Private` _enableRealtime

`Private` _eventRecorder

`Private` _eventsUrl

`Private` _getEventsUrl

`Private` _readyPromise

`Private` _realtimePath

`Private` _realtimeUrl

`Private` _refreshInterval

`Private` _status

`Private` _storage

`Private` _timeoutInterval

`Private` `Optional` _timeoutTimer

`Private` `Optional` _timer

`Private` _toggles

`Private` _togglesUrl

`Private` _user

`Private` connectSocket

`Rest` ...args: any[]

`Private` errorInitialized

`Private` fetchToggles

`Optional` callback: Function

`Optional` ctx: any

`Optional` ctx: any

`Private` successInitialized

`Private` toggleDetail

`Private` toggleValue

`Optional` value: unknown

`Static` newForTest