lightswitch-js-sdk/dist/mjs/types.d.ts

light switch javascript sdk

export type LSMessageData = Flag | Title | Switch | string;
export type LSFlagType = 'BOOLEAN' | 'STRING' | 'INTEGER';
export type ErrorCallback = (error: Error) => void;
export type flagChangedCallback = () => void;
export declare enum LogLevel {
    DEBUG = 0,
    INFO = 1,
    WARNING = 2,
    ERROR = 3
}
export interface Logger {
    debug: (message: any) => void;
    info: (message: any) => void;
    warning: (message: any) => void;
    error: (message: any) => void;
}
export interface userKey {
    userKey: string;
}
export interface SdkConfig {
    sdkKey: string;
    onFlagChanged: flagChangedCallback;
    endpoint?: string;
    logLevel?: LogLevel;
    reconnectTime?: number;
    onError?: ErrorCallback;
}
export interface ILSUser {
    userId: null | string;
    properties: Map<string, string>;
    getUserId: () => string;
}
export interface ILightSwitch {
    init: (config: SdkConfig) => void;
    getFlag: <T>(name: string, LSUser: ILSUser, defaultVal: T) => T;
    getBooleanFlag: (name: string, LSUser: ILSUser, defaultVal: boolean) => boolean;
    getIntegerFlag: (name: string, LSUser: ILSUser, defaultVal: number) => number;
    getStringFlag: (name: string, LSUser: ILSUser, defaultVal: string) => string;
    getAllFlags: () => Flags;
    destroy: () => void;
}
export interface ApiResponse<T> {
    code: number;
    message: string;
    data: T;
}
export interface LSMessage {
    userKey: string;
    type: string;
    data: LSMessageData;
}
export interface Title {
    title: string;
}
export interface Switch {
    title: string;
    active: boolean;
}
export type Flags = Map<string, Flag>;
export interface Flag {
    flagId: number;
    title: string;
    description: string;
    type: LSFlagType;
    keywords: Keyword[];
    defaultValue: string;
    defaultValuePortion?: number;
    defaultValueDescription?: string;
    variations?: Variation[];
    maintainerId: number;
    createdAt: string;
    updatedAt: string;
    deleteAt: string | null;
    active: boolean;
}
export interface Variation {
    value: string;
    portion: number;
    description: string;
}
export interface Keyword {
    properties: Property[];
    value: string;
}
export interface Property {
    property: string;
    data: string;
}