Class default

Implements

default

Index

Constructors

Methods

variation variationDetail isFeatureOn featureFlagDetail track remoteConfig updateUserProperties updatePushSubscriptions updateSmsSubscriptions updateKakaoSubscriptions getExperiment onReady onInitialized close

Constructors

constructor

new default(
    core: HackleCore,
    synchronizer: PollingSynchronizer,
    hackleUserResolver: HackleUserResolver,
): default
Parameters
- core: HackleCore
- synchronizer: PollingSynchronizer
- hackleUserResolver: HackleUserResolver
Returns default

Methods

variation

variation(
    experimentKey: number,
    user: string | User,
    defaultVariation?: string,
): string
Determine the variation to expose to the user for experiment.

This method return the {"A"} if:
- The experiment key is invalid
- The experiment has not started yet
- The user is not allocated to the experiment
- The determined variation has been dropped
Parameters
- experimentKey: number
  the unique key of the experiment.
- user: string | User
  the user to participate in the experiment. MUST NOT be null.
- defaultVariation: string = "A"
  the default variation of the experiment.
Returns string
string the decided variation for the user, or the default variation.

Implementation of HackleClient.variation

variationDetail

variationDetail(
    experimentKey: number,
    user: string | User,
    defaultVariation?: string,
): Decision
Determine the variation to expose to the user for experiment, and returns an object that describes the way the variation was determined.
Parameters
- experimentKey: number
  the unique key of the experiment.
- user: string | User
  the user to participate in the experiment. MUST NOT be null. (e.g. { id: "userId"} )
- defaultVariation: string = "A"
  the default variation of the experiment. MUST NOT be null.
Returns Decision
object

Implementation of HackleClient.variationDetail

isFeatureOn

isFeatureOn(featureKey: number, user: string | User): boolean
Determine whether the feature is turned on to the user.
Parameters
- featureKey: number
  the unique key for the feature.
- user: string | User
  the user requesting the feature.
Returns boolean
boolean True if the feature is on. False if the feature is off.

Since
2.0.0

Implementation of HackleClient.isFeatureOn

featureFlagDetail

featureFlagDetail(featureKey: number, user: string | User): FeatureFlagDecision
Determine whether the feature is turned on to the user, and returns an object that describes the way the value was determined.
Parameters
- featureKey: number
  the unique key for the feature.
- user: string | User
  the identifier of user.
Returns FeatureFlagDecision
Since
2.0.0

Implementation of HackleClient.featureFlagDetail

track

track(event: string | HackleEvent<string>, user: string | User): void
Records the event that occurred by the user.
Parameters
- event: string | HackleEvent<string>
  the unique key of the event that occurred. MUST NOT be null.
- user: string | User
  the user that occurred the event. MUST NOT be null.
Returns void
Implementation of HackleClient.track

remoteConfig

remoteConfig(user: User): HackleRemoteConfig
Returns a instance of Hackle Remote Config.
Parameters
- user: User
  the identifier of user.
Returns HackleRemoteConfig
Implementation of HackleClient.remoteConfig

updateUserProperties

updateUserProperties(operations: PropertyOperations, user: User): void
Updates the user's properties.
Parameters
- operations: PropertyOperations
  Property operations to update user properties.
- user: User
  the user whose properties will be updated
Returns void
Implementation of HackleClient.updateUserProperties

updatePushSubscriptions

updatePushSubscriptions(
operations: HackleSubscriptionOperations,
user: User,
): void
Parameters
- operations: HackleSubscriptionOperations
- user: User
Returns void

updateSmsSubscriptions

updateSmsSubscriptions(
operations: HackleSubscriptionOperations,
user: User,
): void
Parameters
- operations: HackleSubscriptionOperations
- user: User
Returns void

updateKakaoSubscriptions

updateKakaoSubscriptions(
operations: HackleSubscriptionOperations,
user: User,
): void
Parameters
- operations: HackleSubscriptionOperations
- user: User
Returns void

getExperiment

getExperiment(experimentKey: number): HackleExperiment
Parameters
- experimentKey: number
Returns HackleExperiment
Implementation of HackleClient.getExperiment

onReady

onReady(block: () => void, timeout?: number): void
Parameters
- block: () => void
  callback function.
- timeout: number = DEFAULT_ON_READY_TIMEOUT
Returns void
Deprecated
use onInitialized instead.

Implementation of HackleClient.onReady

onInitialized

onInitialized(config?: { timeout?: number }): Promise<{ success: boolean }>
Parameters
- Optionalconfig: { timeout?: number }
Returns Promise<{ success: boolean }>
Implementation of HackleClient.onInitialized

close

close(): void
Returns void
Implementation of HackleClient.close

Class default

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

variation

Parameters

Returns string

variationDetail

Parameters

Returns Decision

isFeatureOn

Parameters

Returns boolean

Since

featureFlagDetail

Parameters

Returns FeatureFlagDecision

Since

track

Parameters

Returns void

remoteConfig

Parameters

Returns HackleRemoteConfig

updateUserProperties

Parameters

Returns void

updatePushSubscriptions

Parameters

Returns void

updateSmsSubscriptions

Parameters

Returns void

updateKakaoSubscriptions

Parameters

Returns void

getExperiment

Parameters

Returns HackleExperiment

onReady

Parameters

Returns void

Deprecated

onInitialized

Parameters

Returns Promise<{ success: boolean }>

close

Returns void

Settings

On This Page