drip-table/lib/utils/ajv.d.ts

A tiny and powerful enterprise-class solution for building tables.

/**
 * This file is part of the drip-table project.
 * @link     : https://drip-table.jd.com/
 * @author   : Emil Zhai (root@derzh.com)
 * @modifier : Emil Zhai (root@derzh.com)
 * @copyright: Copyright (c) 2021 JD Network Technology Co., Ltd.
 */
import { SchemaObject } from "../types";
export interface AjvOptions {
    /**
     * Schema 校验时是否允许多余的数据
     */
    additionalProperties?: boolean;
}
export declare const DRIP_TABLE_CSS_SCHEMA: SchemaObject;
export declare const DRIP_TABLE_GENERIC_CSS_SCHEMA: SchemaObject;
export declare const validateDripTableRequiredProps: (props: unknown, options?: AjvOptions) => string | null;
/**
 * 根据用户传入的表格属性获取需要校验的属性名称列表，输出固定长度的结果提供给 React Hooks 使用
 * @param props DripTable 用户传入属性 props 对象
 * @param options ajv 校验选项
 * @returns 需要校验的属性名称列表
 */
export declare const getDripTableValidatePropsKeys: (props: object, options?: AjvOptions) => string[];
/**
 * 校验 DripTable Props 是否符合 Schema 要求
 * @param key DripTable Props key
 * @param value DripTable Props value
 * @param options ajv 校验选项
 * @returns 校验失败提示内容，成功返回 null
 */
export declare const validateDripTableProp: (key: string, value: unknown, options?: AjvOptions) => string | null;
/**
 * 校验 DripTableColumnSchema 是否符合 Schema 要求
 * @param data DripTableColumnSchema 数据
 * @param schema DripTableColumnSchema 的 Schema 对象
 * @param options ajv 校验选项
 * @returns 校验失败提示内容，成功返回 null
 */
export declare const validateDripTableColumnSchema: (data: unknown, schema?: SchemaObject, options?: AjvOptions) => string | null;