Class AsyncMultiEditorAdapter

Hierarchy (View Summary)

MultiEditorAdapter
- AsyncMultiEditorAdapter

Implements

AsyncAdapterInterface

Index

Constructors

Properties

isAsync requiresSynchronization

Methods

addSingleAdapter extractContentForCheck getAdapterForMatch getFormat registerCheckCall registerCheckResult remapMatches removeAllAdapters replaceRanges selectRanges

Constructors

constructor

new AsyncMultiEditorAdapter(
config?: MultiEditorAdapterConfig,
): AsyncMultiEditorAdapter
Parameters
- config: MultiEditorAdapterConfig = {}
Returns AsyncMultiEditorAdapter
Inherited from MultiEditorAdapter.constructor
- Defined in adapters/MultiEditorAdapter.ts:128

Properties

`Readonly`isAsync

isAsync: true = ...

`Readonly`requiresSynchronization

requiresSynchronization: true = ...

Methods

addSingleAdapter

addSingleAdapter(
    singleAdapter: AdapterInterface | AsyncAdapterInterface,
    opts?: WrapperConfOptions,
    id?: string,
): void
Parameters
- singleAdapter: AdapterInterface | AsyncAdapterInterface
- opts: WrapperConfOptions = {}
- Optionalid: string
Returns void
Overrides MultiEditorAdapter.addSingleAdapter
- Defined in adapters/AsyncMultiEditorAdapter.ts:26

extractContentForCheck

extractContentForCheck(
opts: ExtractContentForCheckOpts,
): Promise<ContentExtractionResult>
Parameters
- opts: ExtractContentForCheckOpts
Returns Promise<ContentExtractionResult>
Implementation of AsyncAdapterInterface.extractContentForCheck
Inherited from MultiEditorAdapter.extractContentForCheck
- Defined in adapters/MultiEditorAdapter.ts:156

getAdapterForMatch

getAdapterForMatch(match: Match): CheckedRegisteredAdapter
Parameters
- match: Match
Returns CheckedRegisteredAdapter
Inherited from MultiEditorAdapter.getAdapterForMatch
- Defined in adapters/MultiEditorAdapter.ts:232

getFormat

getFormat(): "HTML" | "AUTO"
Returns "HTML" | "AUTO"
Implementation of AsyncAdapterInterface.getFormat
Inherited from MultiEditorAdapter.getFormat
- Defined in adapters/MultiEditorAdapter.ts:136

registerCheckCall

registerCheckCall(_checkInfo: Check): void
Parameters
- _checkInfo: Check
Returns void
Implementation of AsyncAdapterInterface.registerCheckCall
Inherited from MultiEditorAdapter.registerCheckCall
- Defined in adapters/MultiEditorAdapter.ts:193

registerCheckResult

registerCheckResult(checkResult: SuccessfulCheckResult): void
Parameters
- checkResult: SuccessfulCheckResult
Returns void
Implementation of AsyncAdapterInterface.registerCheckResult
Inherited from MultiEditorAdapter.registerCheckResult
- Defined in adapters/MultiEditorAdapter.ts:195

remapMatches

remapMatches<T extends Match>(
matches: T[],
): { [id: string]: RemappedMatches<T> }
Type Parameters
- T extends Match
Parameters
- matches: T[]
Returns { [id: string]: RemappedMatches<T> }
Inherited from MultiEditorAdapter.remapMatches
- Defined in adapters/MultiEditorAdapter.ts:210

removeAllAdapters

removeAllAdapters(): void
Returns void
Inherited from MultiEditorAdapter.removeAllAdapters
- Defined in adapters/MultiEditorAdapter.ts:152

replaceRanges

replaceRanges(
checkId: string,
matchesWithReplacement: MatchWithReplacement[],
): Promise<void>
Parameters
- checkId: string
- matchesWithReplacement: MatchWithReplacement[]
Returns Promise<void>
Implementation of AsyncAdapterInterface.replaceRanges
Overrides MultiEditorAdapter.replaceRanges
- Defined in adapters/AsyncMultiEditorAdapter.ts:41

selectRanges

selectRanges(checkId: string, matches: Match[]): Promise<void>
Parameters
- checkId: string
- matches: Match[]
Returns Promise<void>
Implementation of AsyncAdapterInterface.selectRanges
Overrides MultiEditorAdapter.selectRanges
- Defined in adapters/AsyncMultiEditorAdapter.ts:34