prorm API Reference
    Preparing search index...

    Interface BreachDetectorOptions

    Configuration options for BreachDetector

    interface BreachDetectorOptions {
        alertCallback?: (alert: BreachAlert) => void;
        massExportThreshold?: number;
        rateLimitWindow?: number;
        rateLimitMax?: number;
        failedAuthThreshold?: number;
        failedAuthWindow?: number;
        detectUnusualAccessTime?: boolean;
        allowedHours?: number[];
        detectSuspiciousPatterns?: boolean;
        maxAlerts?: number;
        minAlertSeverity?: BreachSeverity;
        customPatterns?: RegExp[];
        trackByUser?: boolean;
        trackByIP?: boolean;
    }
    Index
    alertCallback? massExportThreshold? rateLimitWindow? rateLimitMax? failedAuthThreshold? failedAuthWindow? detectUnusualAccessTime? allowedHours? detectSuspiciousPatterns? maxAlerts? minAlertSeverity? customPatterns? trackByUser? trackByIP?
    alertCallback?: (alert: BreachAlert) => void

    Callback for real-time alerts to security team

    massExportThreshold?: number

    Maximum records that can be exported in a single query before alerting

    rateLimitWindow?: number

    Time window for rate limiting in milliseconds

    rateLimitMax?: number

    Maximum queries allowed per rate limit window

    failedAuthThreshold?: number

    Number of failed auth attempts before alerting

    failedAuthWindow?: number

    Time window for failed auth tracking in milliseconds

    detectUnusualAccessTime?: boolean

    Enable detection of unusual access times

    allowedHours?: number[]

    Allowed hours (24h format) for normal access

    detectSuspiciousPatterns?: boolean

    Enable suspicious query pattern detection

    maxAlerts?: number

    Maximum alerts to keep in memory

    minAlertSeverity?: BreachSeverity

    Minimum severity to trigger alert callback

    customPatterns?: RegExp[]

    Custom suspicious query patterns (regex)

    trackByUser?: boolean

    Track queries by user ID

    trackByIP?: boolean

    Track queries by IP address

    Settings
    Member Visibility

    On This Page
    Properties