Interface AsyncAdapterInterface

interface AsyncAdapterInterface {
    isAsync: true;
    requiresSynchronization: boolean;
    extractContentForCheck(
        opts: ExtractContentForCheckOpts,
    ): ContentExtractionResult | Promise<ContentExtractionResult>;
    getAutobindWrapperAttributes(): AutobindWrapperAttributes;
    getContent(opts: ExtractContentForCheckOpts): string;
    getFormat(): string;
    onInitFinished(result: InitResult): void;
    registerCheckCall(checkInfo: Check): void;
    registerCheckResult(checkResult: SuccessfulCheckResult): void;
    replaceRanges(
        checkId: string,
        matchesWithReplacement: MatchWithReplacement[],
    ): Promise<void>;
    selectRanges(checkId: string, matches: Match[]): Promise<void>;
}

Hierarchy (View Summary)

Implemented by

Properties

isAsync requiresSynchronization

Methods

extractContentForCheck getAutobindWrapperAttributes? getContent? getFormat? onInitFinished? registerCheckCall registerCheckResult replaceRanges selectRanges

Properties

ReadonlyisAsync

isAsync: true

ReadonlyrequiresSynchronization

requiresSynchronization: boolean

Methods

extractContentForCheck

OptionalgetAutobindWrapperAttributes

OptionalgetContent

OptionalgetFormat

OptionalonInitFinished

registerCheckCall

registerCheckResult

replaceRanges

  • replaceRanges(
        checkId: string,
        matchesWithReplacement: MatchWithReplacement[],
    ): Promise<void>

    Parameters

    • checkId: string
    • matchesWithReplacement: MatchWithReplacement[]

    Returns Promise<void>

selectRanges

  • selectRanges(checkId: string, matches: Match[]): Promise<void>

    Parameters

    • checkId: string
    • matches: Match[]

    Returns Promise<void>

Settings

Member Visibility

On This Page

Properties
Methods