Class FeatureProbe

A client for the FeatureProbe API. Applications should instantiate a single FeatureProbe for the lifetime of their application.

Hierarchy

FeatureProbe

Index

Constructors

Properties

_eventRecorder _eventsUrl _logger _prerequisiteMaxDeep _realtimeUrl _refreshInterval _remoteUrl _repository _serverSdkKey _toggleSyncer _togglesUrl

Accessors

Methods

booleanDetail booleanValue close connectSocket flush jsonDetail jsonValue numberDetail numberValue start stringDetail stringValue toggleDetail track

Constructors

constructor

new FeatureProbe(__namedParameters: FPConfig): FeatureProbe
Creates a new client instance that connects to FeatureProbe. Undefined optional parameters will be set as the default configurations.
Parameters
- __namedParameters: FPConfig
Returns FeatureProbe
- Defined in FeatureProbe.ts:63

Properties

`Private` `Readonly` _eventRecorder

_eventRecorder: EventRecorder

`Private` `Readonly` _eventsUrl

_eventsUrl: string

`Private` `Readonly` _logger

_logger: Logger<LoggerOptions>

`Private` `Readonly` _prerequisiteMaxDeep

_prerequisiteMaxDeep: number

`Private` `Readonly` _realtimeUrl

_realtimeUrl: string

`Private` `Readonly` _refreshInterval

_refreshInterval: number

`Private` `Readonly` _remoteUrl

_remoteUrl: string

`Private` `Readonly` _repository

_repository: Repository

`Private` `Readonly` _serverSdkKey

_serverSdkKey: string

`Private` `Readonly` _toggleSyncer

_toggleSyncer: Synchronizer

`Private` `Readonly` _togglesUrl

_togglesUrl: string

Accessors

initialized

get initialized(): boolean
Returns boolean
- Defined in FeatureProbe.ts:48

Methods

booleanDetail

booleanDetail(key: string, user: FPUser, defaultValue: boolean): FPToggleDetail
Gets the detailed evaluation results of a boolean toggle.
Parameters
- key: string
  
  toggle key
- user: FPUser
  
  user to be evaluated
- defaultValue: boolean
  
  default return value
Returns FPToggleDetail
- Defined in FeatureProbe.ts:199

booleanValue

booleanValue(key: string, user: FPUser, defaultValue: boolean): boolean
Gets the evaluated value of a boolean toggle.
Parameters
- key: string
  
  toggle key
- user: FPUser
  
  user to be evaluated
- defaultValue: boolean
  
  default return value
Returns boolean
- Defined in FeatureProbe.ts:159

close

close(): Promise<void>
Closes the FeatureProbe client, this would properly clean the memory and report all events.

Returns Promise<void>
- Defined in FeatureProbe.ts:139

`Private` connectSocket

connectSocket(): Promise<void>
Returns Promise<void>
- Defined in FeatureProbe.ts:322

flush

flush(): void
Manually events push.

Returns void
- Defined in FeatureProbe.ts:149

jsonDetail

jsonDetail(key: string, user: FPUser, defaultValue: object): FPToggleDetail
Gets the detailed evaluation results of a json toggle.
Parameters
- key: string
  
  toggle key
- user: FPUser
  
  user to be evaluated
- defaultValue: object
  
  default return value
Returns FPToggleDetail
- Defined in FeatureProbe.ts:229

jsonValue

jsonValue(key: string, user: FPUser, defaultValue: any): any
Gets the evaluated value of a json toggle.
Parameters
- key: string
  
  toggle key
- user: FPUser
  
  user to be evaluated
- defaultValue: any
  
  default return value
Returns any
- Defined in FeatureProbe.ts:189

numberDetail

numberDetail(key: string, user: FPUser, defaultValue: number): FPToggleDetail
Gets the detailed evaluation results of a number toggle.
Parameters
- key: string
  
  toggle key
- user: FPUser
  
  user to be evaluated
- defaultValue: number
  
  default return value
Returns FPToggleDetail
- Defined in FeatureProbe.ts:209

numberValue

numberValue(key: string, user: FPUser, defaultValue: number): number
Gets the evaluated value of a number toggle.
Parameters
- key: string
  
  toggle key
- user: FPUser
  
  user to be evaluated
- defaultValue: number
  
  default return value
Returns number
- Defined in FeatureProbe.ts:169

start

start(startWait?: number): Promise<void>
Initializes the toggle repository.
Parameters
- Optional startWait: number
  
  set time limit for initialization, if not set, this function won't be timeout
Returns Promise<void>
- Defined in FeatureProbe.ts:114

stringDetail

stringDetail(key: string, user: FPUser, defaultValue: string): FPToggleDetail
Gets the detailed evaluation results of a string toggle.
Parameters
- key: string
  
  toggle key
- user: FPUser
  
  user to be evaluated
- defaultValue: string
  
  default return value
Returns FPToggleDetail
- Defined in FeatureProbe.ts:219

stringValue

stringValue(key: string, user: FPUser, defaultValue: string): string
Gets the evaluated value of a string toggle.
Parameters
- key: string
  
  toggle key
- user: FPUser
  
  user to be evaluated
- defaultValue: string
  
  default return value
Returns string
- Defined in FeatureProbe.ts:179

`Private` toggleDetail

toggleDetail(key: string, user: FPUser, defaultValue: any, valueType: ToggleValueType): FPToggleDetail
Parameters
- key: string
- user: FPUser
- defaultValue: any
- valueType: ToggleValueType
Returns FPToggleDetail
- Defined in FeatureProbe.ts:246

track

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

Generated using TypeDoc