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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:34

Properties

`Private` _clientSdkKey

_clientSdkKey: any

`Private` _eventRecorder

_eventRecorder: any

`Private` _eventsUrl

_eventsUrl: any

`Private` _getEventsUrl

_getEventsUrl: any

`Private` _readyPromise

_readyPromise: any

`Private` _realtimePath

_realtimePath: any

`Private` _realtimeUrl

_realtimeUrl: any

`Private` _refreshInterval

_refreshInterval: any

`Private` _status

_status: any

`Private` _storage

_storage: any

`Private` _timeoutInterval

_timeoutInterval: any

`Private` `Optional` _timeoutTimer

_timeoutTimer?: any

`Private` `Optional` _timer

_timer?: any

`Private` _toggles

_toggles: any

`Private` _togglesUrl

_togglesUrl: any

`Private` _user

_user: any

`Private` connectSocket

connectSocket: any

`Private` errorInitialized

errorInitialized: any

`Private` fetchToggles

fetchToggles: any

`Private` successInitialized

successInitialized: any

`Private` toggleDetail

toggleDetail: any

`Private` toggleValue

toggleValue: any

Accessors

clientSdkKey

get clientSdkKey(): string
Returns string
- Defined in node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:35

eventRecorder

get eventRecorder(): EventRecorder
Returns EventRecorder
- Defined in node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:38

eventsUrl

get eventsUrl(): string
Returns string
- Defined in node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:37

user

get user(): FPUser
Returns FPUser
- Defined in node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:36

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:141

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:107

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:67

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

flush

flush(): void
Manually push events.

Returns void
- Defined in node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:165

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:150

identifyUser

identifyUser(user: FPUser): void
Changing the current user to FeatureProbe.
Parameters
- user: FPUser
  
  A new FPUser instance.
Returns void
- Defined in node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:157

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:137

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:97

logout

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

Returns void
- Defined in node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:161

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:117

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:77

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:45

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:50

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:127

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:87

track

track(name: string, value?: unknown): void
Record custom events, value is optional.
Parameters
- name: string
- Optional value: unknown
Returns void
- Defined in node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:169

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 node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:57

`Static` newForTest

newForTest(toggles: {
[key: string]: boolean;
}): FeatureProbe
Parameters
- toggles: {
  [key: string]: boolean;
  }
  - [key: string]: boolean
Returns FeatureProbe
- Defined in node_modules/featureprobe-client-sdk-js/dist/src/FeatureProbe.d.ts:39

Class FeatureProbe

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: FPConfig

Returns FeatureProbe

Properties

Private _clientSdkKey

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

Private errorInitialized

Private fetchToggles

Private successInitialized

Private toggleDetail

Private toggleValue

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

emit

Parameters

event: string

Rest ...args: any[]

Returns FeatureProbe

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>

Returns Record<string, unknown>

`Private` _clientSdkKey

`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

`Private` errorInitialized

`Private` fetchToggles

`Private` successInitialized

`Private` toggleDetail

`Private` toggleValue

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

`Rest` ...args: any[]

`Optional` callback: Function

`Optional` ctx: any

`Optional` ctx: any

`Optional` value: unknown

`Static` newForTest

toggles: {
[key: string]: boolean;
}