Class MLEngine

Hierarchy

StrictEventEmitter<MLEngineEventMap>
- MLEngine

Index

Constructors

Properties

#configProvider #core #file #options? #watcher

Accessors

Methods

close createCore exec i18n onChange provide resolveConfig resolveParser resolveRules resolveRuleset resolveSchemas setCode setup watchMode toMLFile

Constructors

constructor

new MLEngine(file: Readonly<MLFile>, options?: APIOptions & MLEngineOptions): MLEngine
Parameters
- file: Readonly<MLFile>
- Optional options: APIOptions & MLEngineOptions
Returns MLEngine
Overrides StrictEventEmitter<MLEngineEventMap>.constructor
- Defined in markuplint/src/api/ml-engine.ts:36

Properties

`Private` #configProvider

#configProvider: ConfigProvider

`Private` #core

#core: null | MLCore = null

`Private` #file

#file: Readonly<MLFile>

`Private` `Optional` #options

#options?: APIOptions & MLEngineOptions

`Private` #watcher

#watcher: FSWatcher = ...

Accessors

document

get document(): null | MLDocument<RuleConfigValue, PlainData>
Returns null | MLDocument<RuleConfigValue, PlainData>
- Defined in markuplint/src/api/ml-engine.ts:48

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in markuplint/src/api/ml-engine.ts:55

`Private` createCore

createCore(fabric: MLFabric): Promise<MLCore>
Parameters
- fabric: MLFabric
Returns Promise<MLCore>
- Defined in markuplint/src/api/ml-engine.ts:136

exec

exec(): Promise<null | MLResultInfo>
Returns Promise<null | MLResultInfo>
- Defined in markuplint/src/api/ml-engine.ts:60

`Private` i18n

i18n(): Promise<LocaleSet>
Returns Promise<LocaleSet>
- Defined in markuplint/src/api/ml-engine.ts:155

`Private` onChange

onChange(filePath: string): Promise<void>
Parameters
- filePath: string
Returns Promise<void>
- Defined in markuplint/src/api/ml-engine.ts:161

`Private` provide

provide(cache?: boolean): Promise<null | MLFabric>
Parameters
- cache: boolean = true
Returns Promise<null | MLFabric>
- Defined in markuplint/src/api/ml-engine.ts:183

`Private` resolveConfig

resolveConfig(cache: boolean): Promise<ConfigSet>
Parameters
- cache: boolean
Returns Promise<ConfigSet>
- Defined in markuplint/src/api/ml-engine.ts:260

`Private` resolveParser

resolveParser(configSet: ConfigSet): Promise<{}>
Parameters
- configSet: ConfigSet
Returns Promise<{}>
- Defined in markuplint/src/api/ml-engine.ts:299

`Private` resolveRules

resolveRules(plugins: readonly Plugin[], ruleset: Ruleset): Promise<Readonly<AnyMLRule>[]>
Parameters
- plugins: readonly Plugin[]
- ruleset: Ruleset
Returns Promise<Readonly<AnyMLRule>[]>
- Defined in markuplint/src/api/ml-engine.ts:309

`Private` resolveRuleset

resolveRuleset(configSet: ConfigSet): Ruleset
Parameters
- configSet: ConfigSet
Returns Ruleset
- Defined in markuplint/src/api/ml-engine.ts:324

`Private` resolveSchemas

resolveSchemas(configSet: ConfigSet): Promise<readonly [MLMLSpec, ExtendedSpec]>
Parameters
- configSet: ConfigSet
Returns Promise<readonly [MLMLSpec, ExtendedSpec]>
- Defined in markuplint/src/api/ml-engine.ts:333

setCode

setCode(code: string): Promise<void>
Parameters
- code: string
Returns Promise<void>
- Defined in markuplint/src/api/ml-engine.ts:112

`Private` setup

setup(): Promise<null | MLCore>
Returns Promise<null | MLCore>
- Defined in markuplint/src/api/ml-engine.ts:342

watchMode

watchMode(enable: boolean): void
Parameters
- enable: boolean
Returns void
- Defined in markuplint/src/api/ml-engine.ts:123

`Static` toMLFile

toMLFile(target: Target): Promise<undefined | MLFile>
Parameters
- target: Target
Returns Promise<undefined | MLFile>
- Defined in markuplint/src/api/ml-engine.ts:25

Generated using TypeDoc