rxdb/dist/types/rx-error.d.ts

A local-first realtime NoSQL Database for JavaScript applications - https://rxdb.info/

/**
 * here we use custom errors with the additional field 'parameters'
 */
import type { RxErrorParameters, RxErrorKey, RxStorageWriteError, RxStorageWriteErrorConflict } from './types/index.d.ts';
export declare class RxError extends Error {
    code: RxErrorKey;
    message: string;
    url: string;
    parameters: RxErrorParameters;
    rxdb: true;
    constructor(code: RxErrorKey, message: string, parameters?: RxErrorParameters);
    get name(): string;
    toString(): string;
    get typeError(): boolean;
}
export declare class RxTypeError extends TypeError {
    code: RxErrorKey;
    message: string;
    url: string;
    parameters: RxErrorParameters;
    rxdb: true;
    constructor(code: RxErrorKey, message: string, parameters?: RxErrorParameters);
    get name(): string;
    toString(): string;
    get typeError(): boolean;
}
export declare function getErrorUrl(code: RxErrorKey): string;
export declare function errorUrlHint(code: RxErrorKey): string;
export declare function newRxError(code: RxErrorKey, parameters?: RxErrorParameters): RxError;
export declare function newRxTypeError(code: RxErrorKey, parameters?: RxErrorParameters): RxTypeError;
/**
 * Returns the error if it is a 409 conflict,
 * return false if it is another error.
 */
export declare function isBulkWriteConflictError<RxDocType>(err?: RxStorageWriteError<RxDocType> | any): RxStorageWriteErrorConflict<RxDocType> | false;
export declare function rxStorageWriteErrorToRxError(err: RxStorageWriteError<any>): RxError;