API Reference

Qingkuai's API is organized by entry package, making on-demand imports easy and keeping responsibility boundaries 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 methods, contexts, reactive side effects, performance optimization, and state conversion.

Type Exports

• BoundEffectFunc

• BoundLifecycleFunc

• BoundSetContextFunc

• BoundSetContextGetterFunc

• BoundWatchFunc

• ComponentContexts

• ComponentExports

• ComponentInstance

• ComponentProps

• ComponentRefs

• ComponentShape

• ComponentSlots

• DeclareComponent

• EffectCallback

• EffectHandle

• HtmlBlockOptions

• WatchCallback

See: Utility Types

Lifecycle

• onAfterDestroyBuiltIn

• onAfterMountBuiltIn

• onAfterUpdateBuiltIn

• onBeforeDestroyBuiltIn

• onBeforeUpdateBuiltIn

See: Lifecycle. Note that inside component files these methods are built-in methods and can be called directly without importing. When importing them from the runtime package, the target component instance must be explicitly passed as the first argument.

Side Effects and Watchers

• effectBuiltIn

• postEffectBuiltIn

• postWatchBuiltIn

• preEffectBuiltIn

• preWatchBuiltIn

• syncEffectBuiltIn

• syncWatchBuiltIn

• watchBuiltIn

See: Watchers and Side Effects. Like the lifecycle methods, when importing them from the runtime package, the first argument is the component instance or null.

Contexts

• getContexts

• setContextBuiltIn

• setContextGetterBuiltIn

Used to operate on the contexts of a specific component instance in external logic: setContext writes a value into the target instance's contexts layer, setContextGetter writes a reactive getter, and getContexts returns the contexts chain-head object of the target instance. Inside component files, use the built-in methods setContext, setContextExp, and setContextGetter together with the built-in identifier contexts instead.

See: Contexts

Reactivity Optimization Controls

• batchAndNoTracking

• batchUpdating

• noTracking

• noUpdating

• pauseTracking

• pauseUpdating

• resumeTracking

• resumeUpdating

• startBatchUpdating

• stopBatchUpdating

State and Scheduling

• createShallowStore

• createStore

• getCurrentInstance

• mountApp

• nextTick

• toRaw

• toReactive

• toShallow

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 exported by the compiler package contains the following properties:

• LSC

• PRESERVED_IDPREFIX

• SPREAD_TAG

Utility Object

The util object exported by the compiler package contains the following properties:

• camel2Kebab

• findEndBracket

• findOutOfComment

• findOutOfLiteral

• findOutOfLiteralComment

• formatSourceCode

• isEmbeddedLanguageTag

• isEmbeddedStyleTag

• isRequiredValueDirective

• isVoidTag

• kebab2Camel

• toPropertyKey

• ts

Flags

• PositionFlag

• TestingMode

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.)