Skip to main content
DeepdotsConfig is exported from the package and can be imported. DeepdotsInitParams is used as the parameter type for the init() method but is not directly exported.

​
DeepdotsInitParams

Configuration options for initializing the DeepdotsPopups SDK. 
export interface DeepdotsInitParams {
    apiKey?: string;
    nodeEnv?: 'development' | 'production';
    mode?: 'server' | 'client';
    debug?: boolean;
    popups?: PopupDefinition[];
    userId?: string;
}

​
Parameters

​
apiKey
string
API key for authentication
​
nodeEnv
'development' | 'production'
Node environment setting
​
mode
'server' | 'client'
Execution mode for the SDK
​
debug
boolean
Enable debug logging
​
popups
PopupDefinition[]
Preloaded popup definitions (for client mode)
​
userId
string
Optional user id to send with popup events

​
DeepdotsConfig

Runtime configuration for the SDK. 
export interface DeepdotsConfig {
    apiKey?: string;
    mode?: 'server' | 'client';
    debug?: boolean;
    popups?: PopupDefinition[];
    userId?: string;
}

​
Parameters

​
apiKey
string
API key for authentication
​
mode
'server' | 'client'
Execution mode: ‘server’ or ‘client’
​
debug
boolean
Enable debug logging
​
popups
PopupDefinition[]
Preloaded popup definitions (for client mode)
​
userId
string
Optional user id to send with popup events

​
Example Usage

import { DeepdotsPopups } from '@magicfeedback/popup-sdk';

const popups = new DeepdotsPopups();
popups.init({
  apiKey: 'your-api-key',
  mode: 'client',
  debug: true,
  userId: 'user-123'
});

Build docs developers (and LLMs) love

Get started for freeTalk to us