ag-grid-community/dist/types/src/validation/validationModule.d.ts

Advanced Data Grid / Data Table supporting Javascript / Typescript / React / Angular / Vue

import type { _ModuleWithoutApi } from '../interfaces/iModule';
import type { DevValidationOptions } from './validationConfig';
type ValidationModuleType = {
    /**
     * Configures development-time diagnostics, then returns the module to register, e.g.
     * `ModuleRegistry.registerModules([ValidationModule.with({ throwOn: ['error'] })])`. Configuration
     * is global (see {@link DevValidationOptions}) — passing different options per grid does not scope
     * them per grid; the last call wins for all grids.
     */
    with: (options?: DevValidationOptions) => _ModuleWithoutApi;
} & _ModuleWithoutApi;
/**
 * Provides extended development-time diagnostics: detailed console warnings for conflicting or
 * invalid grid options and column definition properties. It is intentionally excluded from the
 * `AllCommunityModule` and `AllEnterpriseModule` bundles to keep production builds small.
 *
 * {@link enableDevValidations} is the recommended way to opt into validation; registering this
 * module directly is the equivalent low-level alternative.
 *
 * @feature Validation
 */
export declare const ValidationModule: ValidationModuleType;
/**
 * Registers the {@link ValidationModule}, which surfaces extended development-time diagnostics:
 * detailed console warnings for conflicting or invalid grid options and column definition
 * properties. Without it, console messages are reduced to an error code and a documentation link.
 *
 * The `ValidationModule` is intentionally excluded from the `AllCommunityModule` and
 * `AllEnterpriseModule` bundles to keep production builds small. Use this helper to opt into
 * validation during development, for example:
 *
 * ```js
 * if (process.env.NODE_ENV !== 'production') {
 *     enableDevValidations();
 * }
 * ```
 *
 * This is the promoted equivalent of registering the module yourself, i.e.
 * `ModuleRegistry.registerModules([ValidationModule.with(options)])` (or including
 * `ValidationModule.with(options)` in the `modules` array passed to a framework wrapper).
 *
 * Call this before any grid is created, and from the same scope (module/bundle) that registers
 * your other modules — registration is global, so it must run before grid initialisation to take
 * effect. Configuration is global too: calling again (or registering `ValidationModule.with` per
 * grid) replaces the previous options for all grids, with the last call winning. Not intended for
 * production builds.
 *
 * Pass {@link DevValidationOptions} to configure development-time diagnostics, e.g. `{ throwOn: ['error'] }`.
 */
export declare function enableDevValidations(options?: DevValidationOptions): void;
export {};