VWO FME Node SDK

https://github.com/wingify/vwo-fme-node-sdk
Admin
The VWO Feature Management and Experimentation SDK for Node.js and JavaScript enables feature...
Tokens:24,260
Snippets:245
Trust Score:8.1
License:Apache-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Dependencies

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Run this command to install all required project dependencies via yarn.

```bash
yarn install
```

--------------------------------

### Install VWO FME SDK

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/README.md

Commands to install the SDK using npm or yarn package managers.

```bash
# via npm
npm install vwo-fme-node-sdk --save

# via yarn
yarn add vwo-fme-node-sdk
```

--------------------------------

### Run Development Scripts

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/README.md

Common commands for installing dependencies, compiling TypeScript, and running tests.

```bash
yarn install
```

```bash
yarn tsc
```

```bash
# for production
yarn run test:prod
# for development
yarn run test:dev
```

--------------------------------

### get(request)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/network-layer/classes/NetworkManager.md

Performs a GET request using the provided request model.

```APIDOC
### get(request)

#### Description
Executes an HTTP GET request using the specified request model.

#### Parameters
- **request** (RequestModel) - Required - The request model containing request details.

#### Returns
- **Promise<ResponseModel>** - A promise that resolves to the response model.
```

--------------------------------

### Install Wingify FME SDK dependency

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/MIGRATE.md

Use npm or yarn to add the SDK to your project. Ensure only one Wingify package is used in your package.json.

```bash
# Node.js
npm install wingify-fme-node-sdk --save
# or
yarn add wingify-fme-node-sdk
```

--------------------------------

### GET(request: RequestModel)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/network-layer/interfaces/NetworkClientInterface.md

Sends a GET request to the server using the provided RequestModel.

```APIDOC
## GET(request: RequestModel)

### Description
Sends a GET request to the server.

### Parameters
- **request** (RequestModel) - Required - The RequestModel containing the URL and parameters for the GET request.

### Returns
- **Promise<ResponseModel>** - A Promise that resolves to a ResponseModel containing the response data.
```

--------------------------------

### get()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/services/HooksService/interfaces/IHooksService.md

Retrieves the current hook properties.

```APIDOC
## get()

### Description
Retrieves the current set of hook properties.

### Returns
- **Record<string, any>** - The current hook properties.
```

--------------------------------

### get(key: string)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/storage/Connector/classes/Connector.md

Retrieves data associated with the specified key from the storage connector.

```APIDOC
## get(key: string)

### Description
Retrieves data associated with the specified key from the storage connector.

### Parameters
- **_key** (string) - Required - The key to retrieve data for.

### Returns
- (Promise<dynamic> | Connector) - A promise resolving to the dynamic data or the Connector instance.
```

--------------------------------

### sendGetCall(options)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/XMLUtil/functions/sendGetCall.md

Sends a GET request using the provided options.

```APIDOC
## sendGetCall(options)

### Description
Sends a GET request based on the provided configuration options.

### Parameters
- **options** (any) - Required - Configuration options for the GET request.

### Returns
- **void**
```

--------------------------------

### getBucketValueForUser(hashKey, maxValue?)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/decision-maker/classes/DecisionMaker.md

Gets the bucket value for a user based on the hash key and maximum value.

```APIDOC
## getBucketValueForUser(hashKey, maxValue?)

### Description
Gets the bucket value for a user based on the hash key and maximum value.

### Parameters
- **hashKey** (string) - Required - The hash key for the user
- **maxValue** (number) - Optional - The maximum value for bucket scaling (default: 100)

### Returns
- **number** - The calculated bucket value for the user
```

--------------------------------

### get()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/services/HooksService/classes/default.md

Retrieves the current decision object stored within the service.

```APIDOC
## get()

### Description
Retrieves the decision object currently held by the HooksService.

### Returns
- **Record<string, any>** - The decision object.
```

--------------------------------

### sendGetApiRequest(properties, endpoint)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/NetworkUtil/functions/sendGetApiRequest.md

Sends a GET API request to the specified endpoint with the provided properties.

```APIDOC
## sendGetApiRequest(properties, endpoint)

### Description
Sends a GET API request to the specified endpoint with the given properties.

### Parameters
- **properties** (any) - Properties for the request.
- **endpoint** (any) - Endpoint for the GET request.

### Returns
- **Promise<any>** - The response from the GET request.
```

--------------------------------

### assignRangeValues(data, currentAllocation)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/CampaignUtil/functions/assignRangeValues.md

Assigns start and end range values to a variation based on its weight and returns the step factor.

```APIDOC
## assignRangeValues(data, currentAllocation)

### Description
Assigns start and end range values to a variation based on its weight. This function updates the provided variation model and returns the step factor calculated from the weight.

### Parameters
- **data** (VariationModel) - Required - The variation model to assign range values.
- **currentAllocation** (number) - Required - The current allocation value before this variation.

### Returns
- **number** - The step factor calculated from the variation's weight.
```

--------------------------------

### Initialize and Use VWO SDK

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/README.md

Demonstrates initializing the client, retrieving feature flags, and tracking events.

```javascript
const { init } = require('vwo-fme-node-sdk');

const vwoClient = await vwo.init({
  accountId: '123456', // VWO Account ID
  sdkKey: '32-alpha-numeric-sdk-key', // SDK Key
});

// set user context
const userContext = { id: 'unique_user_id' };
// returns a flag object
const getFlag = await vwoClient.getFlag('feature_key', userContext);
// check if flag is enabled
const isFlagEnabled = getFlag.isEnabled();
// get variable
const intVar = getFlag.getVariable('int_variable_key');

// track event
vwoClient.trackEvent('addToCart', userContext, eventProperties);
```

--------------------------------

### Initialize and use SDK in Browser

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/MIGRATE.md

Include the SDK via script tag and initialize it within the browser environment.

```html
<script src="path/to/wingify-fme-javascript-sdk.min.js"></script>
<script>
  (async () => {
    const client = await init({
      accountId: '123456',
      sdkKey: '32-alpha-numeric-sdk-key',
    });

    const context = { id: 'unique_user_id' };
    const flag = await client.getFlag('feature_key', context);
    console.log(flag.isEnabled());
  })();
</script>
```

--------------------------------

### Initialize multiple SDK instances

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Demonstrates creating isolated SDK instances for different environments or accounts using the init method.

```javascript
const { init } = require('vwo-fme-node-sdk');

// Initialize multiple VWO clients with different account IDs and SDK keys
(async function () {
  // First instance for production environment
  const vwoClientProd = await init({
    accountId: '123456',
    sdkKey: '32-alpha-numeric-sdk-key-prod',
  });

  // Second instance for staging environment
  const vwoClientStaging = await init({
    accountId: '789012',
    sdkKey: '32-alpha-numeric-sdk-key-staging',
  });

  // Each instance operates independently with its own settings and state
  const userContext = { id: 'unique_user_id' };

  // Use production client
  const prodFeature = await vwoClientProd.getFlag('feature_key', userContext);
  console.log('Production feature enabled:', prodFeature.isEnabled());

  // Use staging client
  const stagingFeature = await vwoClientStaging.getFlag('feature_key', userContext);
  console.log('Staging feature enabled:', stagingFeature.isEnabled());
})();
```

--------------------------------

### init(options)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWO/functions/init.md

Initializes a new instance of VWO with the provided configuration options.

```APIDOC
## init(options)

### Description
Initializes a new instance of VWO with the provided options. This function returns a Promise that resolves to an IVWOClient instance.

### Parameters
- **options** (IVWOOptions) - Required - Configuration options for the VWO instance.

### Returns
- **Promise<IVWOClient>** - A promise that resolves to the initialized VWO client instance.
```

--------------------------------

### Initialize and use SDK in Node.js (CommonJS)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/MIGRATE.md

Initialize the client asynchronously and perform flag evaluation, event tracking, and attribute setting.

```javascript
const { init } = require('wingify-fme-node-sdk');

(async () => {
  const client = await init({
    accountId: '123456',
    sdkKey: '32-alpha-numeric-sdk-key',
    logger: { level: 'DEBUG' },
  });

  const context = { id: 'unique_user_id', customVariables: { plan: 'pro' } };

  const flag = await client.getFlag('feature_key', context);

  if (flag.isEnabled()) {
    const variable = flag.getVariable('feature_variable', 'default-value');
    console.log('Variable:', variable);
  }

  await client.trackEvent('event_name', context, { cartValue: 10 });
  await client.setAttribute('attribute_key', 'attribute_value', context);
  await client.setAlias(context, 'alias_id');
})();
```

--------------------------------

### onInit()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWO/functions/onInit.md

Initializes the VWO SDK instance. This function returns a Promise that resolves when the initialization process is complete.

```APIDOC
## onInit()

### Description
Initializes the VWO SDK. This function is an asynchronous operation that returns a Promise.

### Signature
`onInit(): Promise<any>`

### Returns
- **Promise<any>** - A promise that resolves when the initialization is complete.
```

--------------------------------

### Initialize SDK with Integrations

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Configure third-party tool integrations using the callback mechanism during SDK initialization.

```javascript
const vwoClient = await vwo.init({
  sdkKey: '32-alpha-numeric-sdk-key', //replace with the SDK key for your environment
  accountId: '123456', //replace with your VWO account ID
  integrations: {
    callback(properties) {
      // your custom implementation here
    },
  },
});
```

--------------------------------

### new VWOClient(settings, options)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWOClient/classes/VWOClient.md

Initializes a new instance of the VWOClient class.

```APIDOC
## Constructor: new VWOClient(settings, options)

### Description
Initializes a new instance of the VWOClient class with the provided settings and configuration options.

### Parameters
- **settings** (SettingsModel) - Required - The settings model containing configuration for the VWO client.
- **options** (IVWOOptions) - Required - Configuration options for the VWO client.
```

--------------------------------

### build(settings)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWOBuilder/interfaces/IVWOBuilder.md

Constructs and returns an IVWOClient instance using the provided settings.

```APIDOC
## build(settings)

### Description
Constructs and returns an IVWOClient instance using the provided settings.

### Parameters
- **settings** (SettingsModel) - Required - The settings model used to initialize the VWO client.

### Returns
- **IVWOClient** - The initialized VWO client instance.
```

--------------------------------

### Initialize SDK with User Aliasing

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Enable user aliasing during initialization, which requires the gateway service to be configured.

```javascript
const vwoClient = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  isAliasingEnabled: true,
  gatewayService: { url: 'https://custom.gateway.com' },
});
```

--------------------------------

### getSettingsPath(sdkKey, accountId)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/NetworkUtil/functions/getSettingsPath.md

Constructs the settings path with the provided API key and account ID.

```APIDOC
## getSettingsPath(sdkKey, accountId)

### Description
Constructs the settings path with API key and account ID.

### Parameters
- **sdkKey** (string) - Required - The API key.
- **accountId** (string | number) - Required - The account identifier.

### Returns
- **Record<string, dynamic>** - The settings path including API key, random number, and account ID.
```

--------------------------------

### Initialize SDK with Gateway Service

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Configure the VWO client by providing the gateway service URL in the initialization parameters.

```javascript
const vwoClient = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  gatewayService: {
    url: 'https://custom.gateway.com',
  },
});
```

--------------------------------

### new VWOBuilder(options)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWOBuilder/classes/VWOBuilder.md

Constructor for initializing a new VWOBuilder instance with the provided configuration options.

```APIDOC
## Constructor: new VWOBuilder(options)

### Description
Initializes a new instance of the VWOBuilder class, which serves as the entry point for configuring and building the VWO SDK client.

### Parameters
- **options** (IVWOOptions) - Required - Configuration object containing SDK settings.
```

--------------------------------

### getSettings(forceFetch)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/services/SettingsService/classes/SettingsService.md

Retrieves the settings, optionally forcing a fresh fetch from the source.

```APIDOC
## getSettings(forceFetch)

### Description
Retrieves the settings model. If forceFetch is set to true, it bypasses the cache to fetch fresh settings.

### Parameters
- **forceFetch** (boolean) - Optional - If true, forces a fetch from the source. Defaults to false.

### Returns
- **Promise<SettingsModel>** - A promise that resolves to the settings model.
```

--------------------------------

### Initialize and use VWO SDK with TypeScript

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Demonstrates type-safe initialization and flag handling using provided SDK interfaces.

```typescript
import { init, IVWOClient, IVWOOptions, Flag } from 'vwo-fme-node-sdk';
// Example of using IVWOOptions for type-safe configuration
const options: IVWOOptions = {
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
};

// Example of using IVWOClient for type-safe client usage
const vwoClient: IVWOClient = await init(options);

// Example of using Flag interface for type-safe flag handling
const flag: Flag = await vwoClient.getFlag('feature-key', { id: 'user-123' });
const isEnabled: boolean = flag.isEnabled();

const stringVariable: string = flag.getVariable('variable_key', 'default_value');
const booleanVariable: boolean = flag.getVariable('variable_key', true);
const numberVariable: number = flag.getVariable('variable_key', 10);
```

--------------------------------

### new VWO(options)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWO/classes/VWO.md

Initializes a new instance of the VWO class with the provided configuration options.

```APIDOC
## new VWO(options)

### Description
Initializes a new instance of the VWO class with the provided configuration options.

### Parameters
- **options** (IVWOOptions) - Required - Configuration options for the VWO instance.
```

--------------------------------

### vwo.init(config)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Initializes the VWO client with account credentials and optional configurations for integrations, tracking, and event batching.

```APIDOC
## vwo.init(config)

### Description
Initializes the VWO SDK instance. This method is required to start the SDK and configure its behavior.

### Parameters
- **sdkKey** (string) - Required - The SDK key for your environment.
- **accountId** (string) - Required - Your VWO account ID.
- **integrations** (object) - Optional - Configuration for third-party tool integration.
  - **callback** (function) - Required - Function receiving VWO properties to forward to third-party tools.
- **shouldWaitForTrackingCalls** (boolean) - Optional - If true, tracking API calls will wait for server response before resolving promises.
- **batchEventData** (object) - Optional - Configuration for batching network requests.
  - **requestTimeInterval** (number) - Optional - Time interval in seconds to flush events (Default: 600).
  - **eventsPerRequest** (number) - Optional - Max events to batch before sending (Default: 100).
  - **flushCallback** (function) - Optional - Callback executed after events are flushed.

### Request Example
```javascript
const vwoClient = await vwo.init({
  sdkKey: '32-alpha-numeric-sdk-key',
  accountId: '123456',
  batchEventData: {
    requestTimeInterval: 60,
    eventsPerRequest: 100,
    flushCallback: (error, events) => {
      console.log('Events flushed successfully');
    }
  }
});
```
```

--------------------------------

### Initialize and use SDK in Node.js (TypeScript/ESM)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/MIGRATE.md

Use TypeScript types for initialization and flag evaluation in an ESM environment.

```typescript
import { init, IWingifyOptions, IWingifyClient, Flag } from 'wingify-fme-node-sdk';

const options: IWingifyOptions = {
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
};

const client: IWingifyClient = await init(options);

const context = { id: 'unique_user_id' };
const flag: Flag = await client.getFlag('feature_key', context);
const enabled: boolean = flag.isEnabled();
```

--------------------------------

### fetchSettings()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/services/SettingsService/classes/SettingsService.md

Fetches the current settings from the configured source.

```APIDOC
## fetchSettings()

### Description
Retrieves the settings model from the configured source.

### Returns
- **Promise<SettingsModel>** - A promise that resolves to the settings model.
```

--------------------------------

### init(config)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Initializes the VWO client with optional configurations for network retries, HTTPS agent behavior, and edge environment settings.

```APIDOC
## init(config)

### Description
Initializes the VWO SDK client. The configuration object supports nested objects for `retryConfig`, `httpsAgentConfig`, and `edgeConfig` to customize network and environment behavior.

### Parameters
#### retryConfig (Object) - Optional
- **shouldRetry** (Boolean) - Optional - Whether to enable automatic retry on network failures. Default: true
- **maxRetries** (Number) - Optional - Maximum number of retry attempts. Default: 3
- **initialDelay** (Number) - Optional - Initial delay in seconds before first retry. Default: 2
- **backoffMultiplier** (Number) - Optional - Multiplier for exponential backoff. Default: 2

#### httpsAgentConfig (Object) - Optional
- **keepAlive** (Boolean) - Optional - Reuse TCP connections. Default: true
- **maxSockets** (Number) - Optional - Maximum number of sockets per host. Default: 100
- **maxFreeSockets** (Number) - Optional - Maximum number of free sockets. Default: 20
- **timeout** (Number) - Optional - Socket timeout in milliseconds. Default: 60000

#### edgeConfig (Object) - Optional
- **shouldWaitForTrackingCalls** (Boolean) - Required - Ensures tracking calls complete before resolving promises. Default: false

### Example Usage
```javascript
const vwoClient = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  retryConfig: {
    shouldRetry: true,
    maxRetries: 5,
    initialDelay: 3,
    backoffMultiplier: 2
  },
  httpsAgentConfig: {
    keepAlive: true,
    maxSockets: 100,
    maxFreeSockets: 20,
    timeout: 60000
  },
  edgeConfig: {
    shouldWaitForTrackingCalls: true
  }
});
```
```

--------------------------------

### Run Test Suites

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Execute tests for either production or development environments.

```bash
# production tests
yarn run test:prod

# development tests
yarn run test:dev
```

--------------------------------

### new LogManager(config?)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/logger/classes/LogManager.md

Constructor for initializing the LogManager singleton with optional configuration.

```APIDOC
## new LogManager(config?)

### Description
Initializes a new instance of the LogManager class. This class is designed as a singleton to ensure consistent logging behavior throughout the application.

### Parameters
- **config** (Record<string, any>) - Optional - Configuration object used to initialize the logger settings.
```

--------------------------------

### getSettings(force)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWOBuilder/interfaces/IVWOBuilder.md

Retrieves the current settings, optionally forcing a refresh.

```APIDOC
## getSettings(force)

### Description
Retrieves the current settings, optionally forcing a refresh.

### Parameters
- **force** (boolean) - Required - Whether to force a refresh of the settings.

### Returns
- **Promise<dynamic>** - A promise that resolves to the settings data.
```

--------------------------------

### new Storage()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/storage/Storage/classes/Storage.md

Creates a new instance of the Storage class.

```APIDOC
## new Storage()

### Description
Creates a new instance of the Storage class.

### Returns
- **Storage** - A new instance of the Storage class.
```

--------------------------------

### fetchSettings()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWOBuilder/interfaces/IVWOBuilder.md

Fetches the latest settings from the VWO service.

```APIDOC
## fetchSettings()

### Description
Fetches the latest settings from the VWO service.

### Returns
- **Promise<SettingsModel>** - A promise that resolves to the fetched settings model.
```

--------------------------------

### fetchSettings(force?)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWOBuilder/classes/VWOBuilder.md

Fetches settings asynchronously, ensuring no parallel fetches.

```APIDOC
## fetchSettings(force?)

### Description
Fetches settings asynchronously, ensuring no parallel fetches.

### Parameters
- **force** (boolean) - Optional - Force fetch ignoring cache.

### Returns
- **Promise<SettingsModel>** - A promise that resolves to the fetched settings.
```

--------------------------------

### Instance()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/logger/classes/LogManager.md

Retrieves the singleton instance of the LogManager.

```APIDOC
## static Instance()

### Description
Provides access to the singleton instance of LogManager.

### Returns
- **LogManager** - The singleton instance.
```

--------------------------------

### NetworkManager.Instance

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/network-layer/classes/NetworkManager.md

Retrieves the singleton instance of the NetworkManager.

```APIDOC
### static Instance()

#### Description
Returns the singleton instance of the NetworkManager.

#### Returns
- **NetworkManager** - The singleton instance.
```

--------------------------------

### initPolling()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWOBuilder/interfaces/IVWOBuilder.md

Initializes the polling mechanism for settings updates.

```APIDOC
## initPolling()

### Description
Initializes the polling mechanism for settings updates.

### Returns
- **this** - Returns the builder instance for chaining.
```

--------------------------------

### Configure Event Batching

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Optimize network requests by batching events with defined time intervals and event counts.

```javascript
const vwoClient = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  batchEventData: {
    requestTimeInterval: 60, // Flush events every 60 seconds
    eventsPerRequest: 100, // Send up to 100 events per request
    flushCallback: (error, events) => {
      console.log('Events flushed successfully');
      // custom implementation here
    },
  },
});
```

--------------------------------

### checkWhitelistingAndPreSeg(settings, feature, campaign, context, evaluatedFeatureMap, megGroupWinnerCampaigns, storageService, decision)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/DecisionUtil/functions/checkWhitelistingAndPreSeg.md

Evaluates whitelisting and pre-segmentation rules for a specific campaign and feature context.

```APIDOC
## checkWhitelistingAndPreSeg

### Description
Evaluates whitelisting and pre-segmentation criteria for a given campaign and feature to determine if the user qualifies.

### Signature
`checkWhitelistingAndPreSeg(settings, feature, campaign, context, evaluatedFeatureMap, megGroupWinnerCampaigns, storageService, decision): Promise<[boolean, any]>`

### Parameters
- **settings** (SettingsModel) - Required - The settings model instance.
- **feature** (FeatureModel) - Required - The feature model instance.
- **campaign** (CampaignModel) - Required - The campaign model instance.
- **context** (ContextModel) - Required - The user context model.
- **evaluatedFeatureMap** (Map<string, any>) - Required - Map of evaluated features.
- **megGroupWinnerCampaigns** (Map<number, number>) - Required - Map of MEG group winner campaigns.
- **storageService** (IStorageService) - Required - The storage service instance.
- **decision** (any) - Required - The decision object.

### Returns
- **Promise<[boolean, any]>** - A promise that resolves to a tuple containing a boolean indicating qualification status and the decision result.
```

--------------------------------

### Configure Logger Settings

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Control SDK logging verbosity, prefixes, and custom transport handlers.

```javascript
const vwoClient1 = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  logger: {
    level: 'DEBUG',
  },
});
```

```javascript
const vwoClient2 = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  logger: {
    level: 'DEBUG',
    prefix: 'CUSTOM LOG PREFIX',
  },
});
```

```javascript
const vwoClient3 = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  logger: {
    transport: {
      level: 'INFO',
      log: (level, message) => {
        // your custom implementation here
      },
    },
  },
});
```

```javascript
const vwoClient3 = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  logger: {
    transports: [
      {
        level: 'INFO',
        log: (level, message) => {
          // your custom implementation here
        },
      },
      {
        level: 'ERROR',
        log: (level, message) => {
          // your custom implementation here
        },
      },
    ],
  },
});
```

--------------------------------

### Configure Browser Settings

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Customize network transport modes and browser storage providers for browser-based environments.

```javascript
const vwoClient = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  browserConfig: {
    // Control how tracking calls are sent from the browser
    // 'sendBeacon' (default) uses navigator.sendBeacon with XHR fallback
    // 'xhr' forces XHR for all tracking requests including retry functionality
    networkTransportMode: 'sendBeacon',

    // Configure browser storage behavior
    clientStorage: {
      key: 'vwo_data', // defaults to vwo_fme_data
      provider: sessionStorage, // defaults to localStorage
      isDisabled: false, // defaults to false, set to true to disable storage
    },
  },
});
```

--------------------------------

### Implement Custom Storage Connector

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Define a storage class to persist feature flag decisions and pass it during SDK initialization.

```javascript
class StorageConnector extends StorageConnector {
  constructor() {
    super();
  }

  /**
   * Get data from storage
   * @param {string} featureKey
   * @param {string} userId
   * @returns {Promise<Object>}
   */
  async get(featureKey, userId) {
    // return await data (based on featureKey and userId)
  }

  /**
   * Set data in storage
   * @param {object} data
   */
  async set(data) {
    // Set data corresponding to a featureKey and user ID
    // Use data.featureKey and data.userId to store the above data for a specific feature and a user
  }
}

const vwoClient = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  storage: StorageConnector,
});
```

--------------------------------

### attachConnector()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/storage/Storage/classes/Storage.md

Attaches a connector to the storage instance.

```APIDOC
## attachConnector(connector)

### Description
Attaches a connector to the storage instance.

### Parameters
- **connector** (any) - Required - The connector to attach.

### Returns
- **any** - The result of the attachment operation.
```

--------------------------------

### setSettingsAndAddCampaignsToRules(settings, vwoClientInstance)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/SettingsUtil/functions/setSettingsAndAddCampaignsToRules.md

Updates the provided settings and adds campaigns to the rules using the specified VWO client instance.

```APIDOC
## setSettingsAndAddCampaignsToRules(settings, vwoClientInstance)

### Description
Updates the settings object and adds campaigns to the rules for the VWO FME Node SDK.

### Parameters
- **settings** (any) - The settings object to be updated.
- **vwoClientInstance** (any) - The VWO client instance to be used for the operation.

### Returns
- **void**
```

--------------------------------

### Configure Edge Environment

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Enable optimizations for serverless environments like Cloudflare Workers.

```javascript
const vwoClient = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  edgeConfig: {
    shouldWaitForTrackingCalls: true,
  },
});

// at the end flush all events
await vwoClient.flushEvents();
```

--------------------------------

### execute(properties)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/services/HooksService/classes/default.md

Executes the configured callback function with the provided properties.

```APIDOC
## execute(properties)

### Description
Executes the callback function associated with the HooksService instance.

### Parameters
- **properties** (Record<string, any>) - Required - Properties to be passed to the callback function.

### Returns
- **void**
```

--------------------------------

### Storage.Instance

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/storage/Storage/classes/Storage.md

Retrieves the singleton instance of the Storage class.

```APIDOC
## Storage.Instance

### Description
Retrieves the singleton instance of the Storage class.

### Returns
- **Storage** - The singleton instance of the Storage class.
```

--------------------------------

### execute(properties)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/services/HooksService/interfaces/IHooksService.md

Executes the hooks with the provided properties.

```APIDOC
## execute(properties)

### Description
Executes the hooks using the provided properties object.

### Parameters
- **properties** (Record<string, any>) - Required - The properties to be used during hook execution.

### Returns
- **void**
```

--------------------------------

### attachClient(client?)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/network-layer/classes/NetworkManager.md

Attaches a network client to the manager, or uses a default if none provided.

```APIDOC
### attachClient(client?)

#### Description
Attaches a network client to the manager. If no client is provided, a default client is used.

#### Parameters
- **client** (NetworkClientInterface) - Optional - The client to attach.
```

--------------------------------

### getBucketingSeed(userId, campaign, groupId?)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/CampaignUtil/functions/getBucketingSeed.md

Generates a bucketing seed based on user ID, campaign, and optional group ID.

```APIDOC
## getBucketingSeed(userId, campaign, groupId?)

### Description
Generates a bucketing seed based on user ID, campaign, and optional group ID.

### Parameters
- **userId** (string) - Required - The user ID.
- **campaign** (CampaignModel) - Required - The campaign object.
- **groupId** (number) - Optional - The optional group ID.

### Returns
- **string** - The bucketing seed.
```

--------------------------------

### setStorage()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWOBuilder/classes/VWOBuilder.md

Sets the storage connector based on the provided storage options.

```APIDOC
## setStorage()

### Description
Sets the storage connector based on the provided storage options.

### Returns
- **this** - The instance of this builder.
```

--------------------------------

### Logging Methods (debug, info, warn, error, trace)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/logger/classes/LogManager.md

Methods for logging messages at different severity levels.

```APIDOC
## debug(message)
### Description
Logs a debug message.
### Parameters
- **message** (string) - Required - The message to log at debug level.

## info(message)
### Description
Logs an informational message.
### Parameters
- **message** (string) - Required - The message to log at info level.

## warn(message)
### Description
Logs a warning message.
### Parameters
- **message** (string) - Required - The message to log at warn level.

## error(message)
### Description
Logs an error message.
### Parameters
- **message** (string) - Required - The message to log at error level.

## trace(message)
### Description
Logs a trace message.
### Parameters
- **message** (string) - Required - The message to log at trace level.
```

--------------------------------

### setSettingsService()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWOBuilder/classes/VWOBuilder.md

Sets the settings manager with the provided options.

```APIDOC
## setSettingsService()

### Description
Sets the settings manager with the provided options.

### Returns
- **this** - The instance of this builder.
```

--------------------------------

### VWO.Instance()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWO/classes/VWO.md

Retrieves the singleton instance of the VWO class.

```APIDOC
## VWO.Instance()

### Description
Gets the singleton instance of the VWO class.

### Returns
- **dynamic** - The singleton instance of VWO.
```

--------------------------------

### SegmentationManager.Instance

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/segmentation-evaluator/classes/SegmentationManager.md

Retrieves the singleton instance of the SegmentationManager.

```APIDOC
## SegmentationManager.Instance

### Description
Returns the singleton instance of the SegmentationManager.

### Returns
- **SegmentationManager** - The singleton instance.
```

--------------------------------

### checkInUserStorage(settings, featureKey, context)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/segmentation-evaluator/classes/SegmentEvaluator.md

Checks if a feature is enabled for a user by querying the provided storage.

```APIDOC
## checkInUserStorage(settings, featureKey, context)

### Description
Checks if the feature is enabled for the user by querying the storage based on the provided settings and context.

### Parameters
- **settings** (SettingsModel) - Required - The settings model containing configuration.
- **featureKey** (string) - Required - The key of the feature to check.
- **context** (ContextModel) - Required - The user context model.

### Returns
- **Promise<any>** - A promise resolving to a boolean indicating if the feature is enabled for the user.
```

--------------------------------

### post(request)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/network-layer/classes/NetworkManager.md

Performs a POST request using the provided request model.

```APIDOC
### post(request)

#### Description
Executes an HTTP POST request using the specified request model.

#### Parameters
- **request** (RequestModel) - Required - The request model containing request details.

#### Returns
- **Promise<ResponseModel>** - A promise that resolves to the response model.
```

--------------------------------

### set(properties)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/services/HooksService/interfaces/IHooksService.md

Sets the hook properties.

```APIDOC
## set(properties)

### Description
Sets the hook properties to the provided object.

### Parameters
- **properties** (Record<string, any>) - Required - The properties to set.

### Returns
- **void**
```

--------------------------------

### getEventsBaseProperties(setting, eventName, visitorUserAgent, ipAddress)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/NetworkUtil/functions/getEventsBaseProperties.md

Builds generic properties for different tracking calls required by VWO servers.

```APIDOC
## getEventsBaseProperties

### Description
Builds generic properties for different tracking calls required by VWO servers.

### Signature
`getEventsBaseProperties(setting: SettingsModel, eventName: string, visitorUserAgent: string = '', ipAddress: string = ''): Record<string, any>`

### Parameters
- **setting** (SettingsModel) - Required - The settings model instance.
- **eventName** (string) - Required - The name of the event being tracked.
- **visitorUserAgent** (string) - Optional - The user agent string of the visitor. Defaults to empty string.
- **ipAddress** (string) - Optional - The IP address of the visitor. Defaults to empty string.

### Returns
- **Record<string, any>** - An object containing the base properties for the tracking call.
```

--------------------------------

### getFlag(featureKey, context)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/VWOClient/interfaces/IVWOClient.md

Retrieves the flag configuration for a specific feature key based on the provided user context.

```APIDOC
## getFlag(featureKey, context)

### Description
Retrieves the flag configuration for a specific feature key based on the provided user context.

### Parameters
- **featureKey** (string) - The unique key of the feature.
- **context** (Record<string, any>) - The user context object.

### Returns
- **Record<any, any>** - The feature flag configuration.
```

--------------------------------

### track(settings, eventName, eventProperties, context, hooksService)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/api/TrackEvent/classes/TrackApi.md

The track method handles event tracking by verifying the event, creating an impression, and executing associated hooks.

```APIDOC
## track(settings, eventName, eventProperties, context, hooksService)

### Description
Implementation of the track method to handle event tracking. Checks if the event exists, creates an impression, and executes hooks.

### Parameters
- **settings** (SettingsModel) - Required - The settings model configuration.
- **eventName** (string) - Required - The name of the event to track.
- **eventProperties** (any) - Required - Properties associated with the event.
- **context** (ContextModel) - Required - The user context model.
- **hooksService** (HooksService) - Required - The service used to execute hooks.

### Returns
- **Promise<Record<string, boolean>>** - A promise that resolves to a record of tracking results.
```

--------------------------------

### getDataInStorage(featureKey, context)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/services/StorageService/classes/StorageService.md

Retrieves data from storage based on the provided feature key and user context.

```APIDOC
## getDataInStorage(featureKey, context)

### Description
Retrieves data from storage based on the feature key and user ID.

### Parameters
- **featureKey** (any) - Required - The key to identify the feature data.
- **context** (ContextModel) - Required - The user context model.

### Returns
- **Promise<Record<any, any>>** - A promise that resolves to the data retrieved or an error/storage status enum.
```

--------------------------------

### POST(request: RequestModel)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/network-layer/interfaces/NetworkClientInterface.md

Sends a POST request to the server using the provided RequestModel.

```APIDOC
## POST(request: RequestModel)

### Description
Sends a POST request to the server.

### Parameters
- **request** (RequestModel) - Required - The RequestModel containing the URL, headers, and body of the POST request.

### Returns
- **Promise<ResponseModel>** - A Promise that resolves to a ResponseModel containing the response data.
```

--------------------------------

### setConfig(config)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/network-layer/classes/NetworkManager.md

Sets the global configuration for network requests.

```APIDOC
### setConfig(config)

#### Description
Updates the global configuration used for all network requests.

#### Parameters
- **config** (GlobalRequestModel) - Required - The configuration object to apply.
```

--------------------------------

### new LogMessageBuilder(loggerConfig, transportConfig)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/logger/LogMessageBuilder/classes/LogMessageBuilder.md

Constructs a new instance of the LogMessageBuilder.

```APIDOC
## Constructor: new LogMessageBuilder(loggerConfig, transportConfig)

### Description
Creates a new LogMessageBuilder instance with the specified logger and transport configurations.

### Parameters
- **loggerConfig** (Record<string, any>) - Required - Configuration for the logger.
- **transportConfig** (Record<string, any>) - Required - Configuration for the transport mechanism.
```

--------------------------------

### generateBucketValue(hashValue, maxValue, multiplier?)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/decision-maker/classes/DecisionMaker.md

Generates a bucket value based on the hash value, maximum value, and an optional multiplier.

```APIDOC
## generateBucketValue(hashValue, maxValue, multiplier?)

### Description
Generates a bucket value based on the hash value, maximum value, and an optional multiplier.

### Parameters
- **hashValue** (number) - Required - The hash value used for calculation
- **maxValue** (number) - Required - The maximum value for bucket scaling
- **multiplier** (number) - Optional - Optional multiplier to adjust the value (default: 1)

### Returns
- **number** - The calculated bucket value
```

--------------------------------

### set(key: string, data: dynamic)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/storage/Connector/classes/Connector.md

Stores data associated with the specified key in the storage connector.

```APIDOC
## set(key: string, data: dynamic)

### Description
Stores data associated with the specified key in the storage connector.

### Parameters
- **_key** (string) - Required - The key to store data under.
- **_data** (dynamic) - Required - The data to be stored.

### Returns
- (void | Promise<dynamic>) - Returns void or a promise resolving to the stored dynamic data.
```

--------------------------------

### Define User Context Object

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Structure the user context object with required ID and optional attributes like custom variables, user agent, and IP address.

```javascript
const userContext = {
  id: 'unique_user_id',
  customVariables: { age: 25, location: 'US' },
  userAgent:
    'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36',
  ipAddress: '1.1.1.1',
};
```

--------------------------------

### checkUserAgentParser(uaParserMap)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/segmentation-evaluator/classes/SegmentEvaluator.md

Validates if the user's device information matches the expected criteria.

```APIDOC
## checkUserAgentParser(uaParserMap)

### Description
Checks if the user's device information matches the expected criteria provided in the user agent parser map.

### Parameters
- **uaParserMap** (Record<string, string[]>) - Required - Map of expected user agent values.

### Returns
- **Promise<boolean>** - A promise resolving to true if the user agent matches, otherwise false.
```

--------------------------------

### sendPostCall(options)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/XMLUtil/functions/sendPostCall.md

Sends a POST request using the provided options.

```APIDOC
## sendPostCall(options)

### Description
Initiates a POST request based on the provided configuration options.

### Parameters
- **options** (any) - Required - Configuration options for the POST request.

### Returns
- **void**
```

--------------------------------

### FlagApi.get()

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/api/GetFlag/classes/FlagApi.md

Retrieves a feature flag based on the provided feature key, settings, user context, and hooks service.

```APIDOC
## get(featureKey, settings, context, hooksService)

### Description
Retrieves a feature flag configuration based on the specified feature key and provided environment context.

### Parameters
- **featureKey** (string) - The unique identifier for the feature.
- **settings** (SettingsModel) - The settings configuration model.
- **context** (ContextModel) - The user context model.
- **hooksService** (HooksService) - The service used for handling hooks.

### Returns
- **Promise<FeatureModel>** - A promise that resolves to the FeatureModel associated with the requested key.
```

--------------------------------

### every(dslNodes, customVariables)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/segmentation-evaluator/classes/SegmentEvaluator.md

Evaluates an array of DSL nodes using AND logic to determine if all nodes are valid.

```APIDOC
## every(dslNodes, customVariables)

### Description
Evaluates all provided DSL nodes using the AND logic. Returns a promise that resolves to a boolean indicating if all nodes are valid.

### Parameters
- **dslNodes** (Record<string, dynamic>[]) - Required - Array of DSL nodes to evaluate.
- **customVariables** (Record<string, dynamic>) - Required - Custom variables provided for evaluation.

### Returns
- **Promise<boolean>** - A promise resolving to true if all nodes are valid, otherwise false.
```

--------------------------------

### getTrackGoalPayloadData(settings, userId, eventName, eventProperties, visitorUserAgent?, ipAddress?)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/NetworkUtil/functions/getTrackGoalPayloadData.md

Constructs the payload data for tracking goals with custom event properties.

```APIDOC
## getTrackGoalPayloadData

### Description
Constructs the payload data for tracking goals with custom event properties.

### Signature
`getTrackGoalPayloadData(settings: SettingsModel, userId: string | number, eventName: string, eventProperties: Record<string, any>, visitorUserAgent?: string, ipAddress?: string): Record<string, any>`

### Parameters
- **settings** (SettingsModel) - Required - Configuration settings.
- **userId** (string | number) - Required - User identifier.
- **eventName** (string) - Required - Name of the event.
- **eventProperties** (Record<string, any>) - Required - Custom properties for the event.
- **visitorUserAgent** (string) - Optional - Visitor's user agent (default: '').
- **ipAddress** (string) - Optional - Visitor's IP address (default: '').

### Returns
- **Record<string, any>** - The constructed payload data.
```

--------------------------------

### Compile TypeScript

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Use this command to compile the TypeScript source code into JavaScript.

```bash
yarn build
```

--------------------------------

### Configure HTTPS Agent

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Adjust TCP connection reuse and socket pool settings for network calls.

```javascript
const vwoClient = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  httpsAgentConfig: {
    keepAlive: true,
    maxSockets: 100,
    maxFreeSockets: 20,
    timeout: 60000, // in milliseconds -- this is socket timeout
  },
});
```

--------------------------------

### addLinkedCampaignsToSettings(settings)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/FunctionUtil/functions/addLinkedCampaignsToSettings.md

Adds linked campaigns to each feature in the settings object based on rules.

```APIDOC
## addLinkedCampaignsToSettings(settings)

### Description
Adds linked campaigns to each feature in the settings based on rules.

### Parameters
- **settings** (SettingsModel) - Required - The settings file to modify.

### Returns
- **void**
```

--------------------------------

### getFeatureFromKey(settings, featureKey)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/FunctionUtil/functions/getFeatureFromKey.md

Retrieves a feature by its key from the settings object.

```APIDOC
## getFeatureFromKey(settings, featureKey)

### Description
Retrieves a feature by its key from the settings.

### Parameters
- **settings** (SettingsModel) - Required - The settings containing features.
- **featureKey** (string) - Required - The key of the feature to find.

### Returns
- **FeatureModel** - The feature if found, otherwise undefined.
```

--------------------------------

### Implement Feature Flagging with JavaScript

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Use getFlag to retrieve a feature flag object, check its status, and access associated variables.

```javascript
const featureFlag = await vwoClient.getFlag('feature_key', { id: 'unique_user_id' });
const isEnabled = featureFlag.isEnabled();

if (isEnabled) {
  console.log('Feature is enabled!');

  // Get and use feature variable with type safety
  const variableValue = featureFlag.getVariable('feature_variable', 'default_value');
  console.log('Variable value:', variableValue);
} else {
  console.log('Feature is not enabled!');
}
```

--------------------------------

### Track Custom Events with JavaScript

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Use trackEvent to record user interactions or conversions, optionally including event metadata.

```javascript
vwoClient.trackEvent('event_name', { id: 'unique_user_id' }, { amount: 49.99 });
```

--------------------------------

### setAttribute(settings, attributeKey, attributeValue, context)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/api/SetAttribute/classes/SetAttributeApi.md

Sets a user attribute to create an impression for the specified user context.

```APIDOC
## setAttribute

### Description
Creates an impression for a user attribute using the provided settings and context.

### Parameters
- **settings** (SettingsModel) - Required - Configuration settings.
- **attributeKey** (string) - Required - The key of the attribute to set.
- **attributeValue** (any) - Required - The value of the attribute.
- **context** (ContextModel) - Required - Context containing user information.

### Returns
- **void**
```

--------------------------------

### Configure Polling Interval with JavaScript

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/README.md

Define the pollInterval during SDK initialization to control how often the client fetches configuration updates.

```javascript
const vwoClient = await init({
  accountId: '123456',
  sdkKey: '32-alpha-numeric-sdk-key',
  pollInterval: 60000,
});
```

--------------------------------

### buildMessage(template, data)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/utils/LogMessageUtil/functions/buildMessage.md

Constructs a message by replacing placeholders in a template with corresponding values from a data object.

```APIDOC
## buildMessage(template, data)

### Description
Constructs a message by replacing placeholders in a template with corresponding values from a data object.

### Parameters
- **template** (string) - Required - The message template containing placeholders in the format {key}.
- **data** (Record<string, any>) - Optional - An object containing keys and values used to replace the placeholders in the template. Defaults to {}.

### Returns
- **string** - The constructed message with all placeholders replaced by their corresponding values from the data object.
```

--------------------------------

### calculateBucketValue(str, multiplier?, maxValue?)

Source: https://github.com/wingify/vwo-fme-node-sdk/blob/master/docs/packages/decision-maker/classes/DecisionMaker.md

Calculates the bucket value for a given string with optional multiplier and maximum value.

```APIDOC
## calculateBucketValue(str, multiplier?, maxValue?)

### Description
Calculates the bucket value for a given string with optional multiplier and maximum value.

### Parameters
- **str** (string) - Required - The input string to calculate the bucket value for
- **multiplier** (number) - Optional - Optional multiplier to adjust the value (default: 1)
- **maxValue** (number) - Optional - The maximum value for bucket scaling (default: 10000)

### Returns
- **number** - The calculated bucket value
```
Tokens:
Raw