@olakai/sdk
Version:
This document demonstrates how to use the Olakai SDK with all its features.
55 lines • 2.3 kB
TypeScript
import type { SDKConfig, JsonValue, SanitizePattern } from "./types";
import { StorageType } from "./types";
/**
* Default sanitize patterns for sanitizing sensitive data.
* @returns An array of sanitize patterns
*/
export declare const DEFAULT_SANITIZE_PATTERNS: SanitizePattern[];
export declare function validateConfig(config: Partial<SDKConfig>): string[];
export declare function getEnvironment(): string;
export declare class ConfigBuilder {
private config;
apiKey(key: string): ConfigBuilder;
monitorEndpoint(url: string): ConfigBuilder;
controlEndpoint(url: string): ConfigBuilder;
version(v: string): ConfigBuilder;
enableBatching(enable?: boolean): ConfigBuilder;
batchSize(size: number): ConfigBuilder;
batchTime(time: number): ConfigBuilder;
retries(count: number): ConfigBuilder;
timeout(ms: number): ConfigBuilder;
enableStorage(enable?: boolean): ConfigBuilder;
storageKey(key: string): ConfigBuilder;
maxStorageSize(size: number): ConfigBuilder;
debug(enable?: boolean): ConfigBuilder;
storageType(type?: StorageType): ConfigBuilder;
sanitizePatterns(patterns: SanitizePattern[]): ConfigBuilder;
verbose(enable?: boolean): ConfigBuilder;
build(): SDKConfig;
}
export declare function createConfig(): ConfigBuilder;
/**
* Sanitize data by replacing sensitive information with a custom placeholder
* @param data - The data to sanitize
* @param patterns - The patterns to replace
* @returns The sanitized data
*/
export declare function sanitizeData(data: string, dataKey?: string, patterns?: SanitizePattern[]): string;
export declare function createErrorInfo(error: any): {
errorMessage: string;
stackTrace?: string;
};
export declare function toJsonValue(val: any, sanitize?: boolean): JsonValue;
/**
* Environment detection utilities
*/
export declare function isBrowser(): boolean;
export declare function isNodeJS(): boolean;
/**
* Sleep for a given number of milliseconds
* @param ms - The number of milliseconds to sleep
* @returns A promise that resolves after the given number of milliseconds
*/
export declare function sleep(ms: number): Promise<void>;
export declare function olakaiLogger(message: string, level?: "info" | "warn" | "error"): void;
//# sourceMappingURL=utils.d.ts.map