@ckeditor/ckeditor5-ai/src/aireviewmode/model/aireviewcheck.d.ts

AI features for CKEditor 5.

/**
 * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
 */
/**
 * @module ai/aireviewmode/model/aireviewcheck
 */
import { type AIReviewCheckDefinition, type AIReviewCheckOptions } from '../aireviewcheckdefinitions.js';
/**
 * Represents the single type of check that can be performed in the AI Review Mode.
 */
export declare class AIReviewCheck {
    /**
     * The unique ID of the check.
     */
    readonly id: string;
    /**
     * The title of the check.
     */
    readonly title: string;
    /**
     * The description of the check.
     */
    readonly description: string;
    /**
     * Indicates whether the check requires additional parameters.
     * For example, a "Change to [tone]" check would require a tone parameter.
     */
    isParameterized: boolean;
    /**
     * Indicates whether the check should use additional arguments (like language) when executed.
     */
    useArgs?: boolean;
    /**
     * Additional options for the check, if any.
     */
    options?: Array<AIReviewCheckOptions>;
    /**
     * Creates a new instance of the AIReviewCheck.
     */
    constructor({ id, title, description, isParameterized, useArgs, options }: AIReviewCheckDefinition);
}