@ckeditor/ckeditor5-ai
Version:
AI features for CKEditor 5.
55 lines (54 loc) • 1.54 kB
TypeScript
/**
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
*/
/**
* @module ai/aireviewcore/model/aireviewcheck
*/
import { type AIReviewCheckDefinition, type AIReviewCheckOptions } from '../types.js';
/**
* Represents the single type of check that can be performed in the AI Review.
*/
export declare class AIReviewCheck {
/**
* The unique ID of the check.
*/
readonly id: string;
/**
* The command ID of the check, used in the API communication.
*/
readonly commandId: 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>;
/**
* Additional arguments for the check, if any.
*/
args?: Record<string, any>;
/**
* The API ID of the check.
*/
get apiId(): string;
/**
* Creates a new instance of the AIReviewCheck.
*/
constructor(checkDefinition: AIReviewCheckDefinition);
}