macoolka-error/lib/invariant.d.ts

`macoolka-cache` Build a cache for function

/**
 * @file
 */
import { WarnMessage } from './types';
/**
 * @since 0.2.0
 */
export declare class InvariantError extends Error {
    framesToPop: number;
    name: string;
    constructor(message?: string);
}
/**
 * @since 0.2.0
 */
export interface Props<T = any> {
    /**
     * Message Title
     * @desczh
     * 消息标题
     */
    title?: string;
    /**
     * Message Content
     * @desczh
     * 消息
     */
    message: string;
    /**
     * The Object will be checked
     * @desczh
     * 这个值将被校验是否为空
     */
    value: T;
}
/**
 * Throw a InvariantError with message when value not is true
 * @desczh
 * 当value不为真时抛出InvariantError
 * @since 0.2.1
 */
export declare function invariant<T>({ value, message, title }: Props<T>): void;
/**
 * Call warn and return a defualt value with message when value not is true
 * @desczh
 * 当value不为真时返回缺省值并调用warn
 * @since 0.2.0
 */
export declare function invariantWarn<T>({ title, value, message, defaultValue, warn }: WarnMessage<Props<T>, T>): T;