## statsig
The global statsig class for interacting with gates, configs, experiments configured in the statsig developer console. Also used for event logging to view in the statsig console, or for analyzing experiment impacts using pulse.
**Kind**: global constant
- [statsig](#statsig)
- [.initialize(secretKey, [options])](#statsig.initialize) ⇒ Promise.<void>
- [.checkGate(user, gateName)](#statsig.checkGate) ⇒ Promise.<boolean>
- [.getConfig(user, configName)](#statsig.getConfig) ⇒ [Promise.<DynamicConfig>](#DynamicConfig)
- [.getExperiment(user, experimentName)](#statsig.getExperiment) ⇒ [Promise.<DynamicConfig>](#DynamicConfig)
- [.logEvent(user, eventName, value, metadata)](#statsig.logEvent)
- [.shutdown()](#statsig.shutdown)
### statsig.initialize(secretKey, [options]) ⇒ Promise.<void>
Initializes the statsig server SDK. This must be called before checking gates/configs or logging events.
**Kind**: static method of [statsig](#statsig)
**Returns**: Promise.<void> - - a promise which rejects only if you fail to provide a proper SDK Key
**Throws**:
- Error if a Server Secret Key is not provided
| Param | Type | Default | Description |
| --------- | ---------------------------------------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| secretKey | string | | The secret key for this project from the statsig console. Secret keys should be kept secure on the server side, and not used for client-side integrations |
| [options] | [StatsigOptions](#StatsigOptions) | {} | manual sdk configuration for advanced setup |
### statsig.checkGate(user, gateName) ⇒ Promise.<boolean>
Check the value of a gate configured in the statsig console
**Kind**: static method of [statsig](#statsig)
**Returns**: Promise.<boolean> - - The value of the gate for the user. Gates are off (return false) by default
**Throws**:
- Error if initialize() was not called first
- Error if the gateName is not provided or not a non-empty string
| Param | Type | Description |
| -------- | ---------------------------------------- | ------------------------------------- |
| user | [StatsigUser](#StatsigUser) | the user to check this gate value for |
| gateName | string | the name of the gate to check |
### statsig.getConfig(user, configName) ⇒ [Promise.<DynamicConfig>](#DynamicConfig)
Checks the value of a config for a given user
**Kind**: static method of [statsig](#statsig)
**Returns**: [Promise.<DynamicConfig>](#DynamicConfig) - - the config for the user
**Throws**:
- Error if initialize() was not called first
- Error if the configName is not provided or not a non-empty string
| Param | Type | Description |
| ---------- | ---------------------------------------- | ------------------------------------------ |
| user | [StatsigUser](#StatsigUser) | the user to evaluate for the dyamic config |
| configName | string | the name of the dynamic config to get |
### statsig.getExperiment(user, experimentName) ⇒ [Promise.<DynamicConfig>](#DynamicConfig)
Checks the value of a config for a given user
**Kind**: static method of [statsig](#statsig)
**Returns**: [Promise.<DynamicConfig>](#DynamicConfig) - - the experiment for the user, represented by a Dynamic Config
**Throws**:
- Error if initialize() was not called first
- Error if the experimentName is not provided or not a non-empty string
| Param | Type | Description |
| --- | --- | --- |
| user | [StatsigUser](#typedefs.StatsigUser) | the user to evaluate for the dyamic config |
| experimentName | string | the name of the experiment to get |
### statsig.logEvent(user, eventName, value, metadata)
Log an event for data analysis and alerting or to measure the impact of an experiment
**Kind**: static method of [statsig](#statsig)
**Throws**:
- Error if initialize() was not called first
| Param | Type | Description |
| --------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------- |
| user | [StatsigUser](#StatsigUser) | the user associated with this event |
| eventName | string | the name of the event (name = Purchase) |
| value | string \| number | the value associated with the event (value = 10) |
| metadata | Record.<string, string> | other attributes associated with this event (metadata = {item_name: 'banana', currency: 'USD'}) |
### statsig.shutdown()
Informs the statsig SDK that the server is closing or shutting down
so the SDK can clean up internal state
**Kind**: static method of [statsig](#statsig)
## DynamicConfig
Returns the data for a DynamicConfig in the statsig console via typed get functions
**Kind**: global class
- [DynamicConfig](#DynamicConfig)
- [.get([key], [defaultValue])](#DynamicConfig+get) ⇒ T \| null
- [.getValue([key], [defaultValue])](#DynamicConfig+getValue) ⇒ boolean \| number \| string \| object \| Array.<any> \| null
### dynamicConfig.get([key], [defaultValue]) ⇒ T \| null
A generic, type sensitive getter, which returns the value at the given index in the config if it matches the type of the default value,
and returns the default value otherwise
**Kind**: instance method of [DynamicConfig](#DynamicConfig)
| Param | Type | Description |
| -------------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| [key] | string | The index of the config to check |
| [defaultValue] | T \| null | The default value of the parameter to return in cases where the parameter is not found or does not match the type of the default value |
### dynamicConfig.getValue([key], [defaultValue]) ⇒ boolean \| number \| string \| object \| Array.<any> \| null
With no parameters, returns the JSON object representing this config (or null if not found)
With a key parameter, returns the value at that index in the JSON object, or null if not found
With a key and a defaultValue, returns the value at that index, or the provided default if not found
**Kind**: instance method of [DynamicConfig](#DynamicConfig)
| Param | Type | Default | Description |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- | -------------------------------------------------------------------------------------- |
| [key] | string | | The index of the config to check |
| [defaultValue] | boolean \| number \| string \| object \| Array.<any> \| null | Object.<string, \*>
- [StatsigOptions](#StatsigOptions) : Object.<string, \*>
### StatsigUser : Object.<string, \*>
An object of properties relating to a user
**Properties**
| Name | Type |
| --------------- | ----------------------------------------------------------------------------------- |
| [userID] | string \| number |
| [email] | string |
| [ip] | string |
| [userAgent] | string |
| [country] | string |
| [locale] | string |
| [appVersion] | string |
| [custom] | Object.<string, (string\|number\|boolean\|Array.<string>)> |
### StatsigOptions : Object.<string, \*>
An object of properties for initializing the sdk with advanced options
**Properties**
| Name | Type |
| ---------------------- | ---------------------------------------------------------- |
| [api] | string |
| [environment] | Object.<string, string> |
| [bootstrapValues] | string |
| [rulesUpdatedCallback] | [rulesUpdatedCallback](#rulesUpdatedCallback) |
**Kind**: static method of [statsig](#statsig)
## rulesUpdatedCallback ⇒ void
Callback function to be executed when the rules have been updated.
**Kind**: global typedef
| Param | Type |
| ----------- | ------------------- |
| [rulesJSON] | string |
| [time] | number |