Node.js SDK Getting Started

To use the DevCycle Server SDK in your project, import the @devcycle/nodejs-server-sdk package and call initializeDevCycle with your DevCycle SDK server key. You may optionally await for the client to be initialized.

JS Example:

const DevCycle = require('@devcycle/nodejs-server-sdk')

const devcycleClient = await DevCycle.initializeDevCycle(
  process.env.DEVCYCLE_SERVER_SDK_KEY,
).onClientInitialized()

Typescript Example:

import { initializeDevCycle } from '@devcycle/nodejs-server-sdk'

const devcycleClient = await initializeDevCycle(
  process.env.DEVCYCLE_SERVER_SDK_KEY,
).onClientInitialized()

Initialization Options

The SDK exposes various initialization options which can be set on the initialization() method:

DevCycleOptions Typescript Schema

const devcycleClient = await DevCycle.initializeDevCycle(
  '<DEVCYCLE_SERVER_SDK_KEY>',
  {
    configPollingIntervalMS: 60 * 1000,
  },
).onClientInitialized()

DevCycle Option	Type	Description
logger	DevCycleLogger	Logger override to replace default logger
logLevel	String	Set log level of the default logger. Options are: `debug`, `info`, `warn`, `error`. Defaults to `info`.
enableCloudBucketing	Boolean	Switches the SDK to use Cloud Bucketing (via the DevCycle Bucketing API) instead of Local Bucketing.
enableEdgeDB	Boolean	Enables the usage of EdgeDB for DevCycle that syncs User Data to DevCycle. NOTE: This is only available with Cloud Bucketing.
configPollingIntervalMS	Number	Controls the polling interval in milliseconds to fetch new environment config changes, defaults to 10 seconds, minimum value is 1 second.
configPollingTimeoutMS	Number	Controls the request timeout to fetch new environment config changes, defaults to 5 seconds, must be less than the configPollingIntervalMS value, minimum value is 1 second.
eventFlushIntervalMS	Number	Controls the interval between flushing events to the DevCycle servers, defaults to 30 seconds.
disableAutomaticEventLogging	Boolean	Disables logging of sdk generated events (e.g. aggVariableEvaluated, aggVariableDefaulted) to DevCycle.
disableCustomEventLogging	Boolean	Disables logging of custom events, from `track()` method, and user data to DevCycle.
flushEventQueueSize	Number	Controls the maximum size the event queue can grow to until a flush is forced. Defaults to `1000`.
maxEventQueueSize	Number	Controls the maximum size the event queue can grow to until events are dropped. Defaults to `2000`.
apiProxyURL	String	Allows the SDK to communicate with a proxy of DevCycle bucketing API / client SDK API.
enableBetaRealtimeUpdates	Boolean	Enables the usage of Beta Realtime Updates for DevCycle. This feature is currently in beta.

Initialization Options​

Initialization Options