API Reference

Qingkuai's API is organized by entry package so that imports stay explicit and responsibilities remain clear. This article lists the public APIs exported from the source entry files of two packages: the runtime package qingkuai and the compiler package qingkuai/compiler.

Runtime

The runtime package exports APIs for component lifecycle hooks, reactive side effects, performance controls, and state conversion.

Type Exports

• ComponentInstance

• HtmlBlockOptions

• QingkuaiComponent

Lifecycle

• onAfterDestroy

• onAfterMount

• onAfterUpdate

• onBeforeDestroy

• onBeforeUpdate

See: Lifecycle

Side Effects and Watchers

• effect

• postEffect

• postWatch

• preEffect

• preWatch

• syncEffect

• syncWatch

• watch

See: Watchers and Side Effects

Reactive Optimization Controls

• batchAndNoTracking

• batchUpdating

• noTracking

• noUpdating

• pauseTracking

• pauseUpdating

• resumeTracking

• resumeUpdating

• startBatchUpdating

• stopBatchUpdating

State and Scheduling

• createShallowStore

• createStore

• mountApp

• nextTick

• toRaw

• toReactive

• toShallowReactive

Other Exports

• DESTRUCT_HTML

• version

Compiler (qingkuai/compiler)

The compiler package is used to parse and compile component source code. It is mainly consumed by build tools, language services, and plugin ecosystems.

Type Exports

• ASTLocation

• ASTPosition

• ASTPositionWithFlag

• CompileIntermediateOptions

• CompileIntermediateResult

• CompileOptions

• CompileResult

• IdentifierStatus

• ScriptDescriptor

• StyleDescriptor

• TemplateAttribute

• TemplateNode

• TemplateNodeContext

• TextContentPart

Constants Object

The constants object contains the following properties:

• LSC

• PRESERVED_IDPREFIX

• SPREAD_TAG

Utility Object

The util object contains the following properties:

• camel2Kebab

• findEndBracket

• findOutOfComment

• findOutOfLiteral

• findOutOfLiteralComment

• formatSourceCode

• isEmbeddedLanguageTag

• isEmbeddedStyleTag

• isRequiredValueDirective

• isVoidTag

• kebab2Camel

• toPropertyKey

• ts

Flags

• PositionFlag

Methods

• compile

• compileIntermediate

• isCompileError

• isCompileWarning

• parseDirectiveValue

• parseEventFlag

• parseTemplate

Edit this page on github (This page has been translated from the Chinese version of the site. There may be inaccuracies in the translation. We welcome your help to improve the accuracy of this document.)