guardflux/dist/lib/types.d.ts

A light callable lib to keep your API alive

export type DBType = 'postgresql' | 'mysql' | 'mongodb';
/**
 * Interface representing the database configuration options.
 */
export interface DbConfig {
    dbName?: string;
    dbType: DBType;
    dbURI: string;
    dbDebug: boolean;
}
/**
 * Interface defining options for rate limiting.
 */
export interface RateLimitOptions {
    route: string;
    cycleTime: number;
    maxRequests: number;
}
/**
 * Interface representing the result of a check operation.
 */
export interface CheckResult {
    isValid: boolean;
    log?: any;
}