export interface DefinedErrorOptions {
    /** 默认错误消息 */
    message?: string;
    /** 错误类型标识，可配合 errorOf({ type }) 使用 */
    type?: string;
}
export interface DefinedErrorInstance<T extends string | undefined, O extends object> extends Error {
    type: T;
    options: O;
}
export interface DefinedErrorClass<T extends string | undefined = undefined, DefaultOpts extends object = object> {
    /** 默认选项 */
    readonly defaultOptions: DefaultOpts | undefined;
    /** 错误类型标识 */
    readonly type: T;
    /** 错误名称 */
    readonly errorName: string;
    new <InstanceOpts extends object = object>(options?: ErrorOptions & InstanceOpts): DefinedErrorInstance<T, DefaultOpts & InstanceOpts>;
    new <InstanceOpts extends object = object>(message?: string, options?: ErrorOptions & InstanceOpts): DefinedErrorInstance<T, DefaultOpts & InstanceOpts>;
    readonly prototype: Error & {
        type: T;
    };
}
/**
 * 方便的定义一个 Error 用来复用错误信息与选项
 *  - 可以预设 message 和 type，配合 errorOf 使用
 *  - 可以附带自定义数据到 options 参数
 *
 * @param errorName 错误名称，如果未提供 message，则默认使用该名称作为错误消息
 * @param defaultOptions 默认选项，可以预设 message 和 type，也可以附带自定义数据
 *
 * @example
 * ```ts
 * const ErrorBadRequest = defineError("Bad Request", { status: 400 })
 *
 * let err = new ErrorBadRequest({ path: "/api/data" })
 * console.log(err.name)    // "Bad Request"
 * console.log(err.message) // "Bad Request"
 * console.log(err.options) // { status: 400, path: "/api/data" }
 *
 * // 使用 is() 方法进行类型安全的判断
 * if (ErrorBadRequest.is(err)) {
 *     console.log(err.options.status) // 类型安全: number
 * }
 * ```
 *
 * @example
 * ```ts
 * // 配合 type 使用
 * const ErrorNotFound = defineError("NotFound", { type: "NOT_FOUND", status: 404 })
 *
 * // 可以通过 errorOf 判断
 * errorOf(err, { type: "NOT_FOUND" })
 * // 或直接使用 is()
 * ErrorNotFound.is(err)
 * ```
 */
export declare function defineError<T extends string | undefined = undefined, DefaultOpts extends object = object>(errorName: string, defaultOptions?: DefinedErrorOptions & {
    type?: T;
} & DefaultOpts): DefinedErrorClass<T, Omit<DefaultOpts, keyof DefinedErrorOptions> & DefinedErrorOptions>;
//# sourceMappingURL=defineError.d.ts.map