ShikiWorkerOwner
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ShikiWorkerOwner(
options?):ShikiWorkerOwner
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”ShikiWorkerOwner
Properties
Section titled “Properties”[shikiLifetimeBinding]
Section titled “[shikiLifetimeBinding]”
readonly[shikiLifetimeBinding]:AbortSignal
[shikiSourceBinding]
Section titled “[shikiSourceBinding]”
readonly[shikiSourceBinding]:DocumentSourceEndpoint
Methods
Section titled “Methods”[shikiOperationBinding]()
Section titled “[shikiOperationBinding]()”[shikiOperationBinding](
options):EditorHighlighterRuntime|null
Parameters
Section titled “Parameters”options
Section titled “options”ShikiHighlighterSessionOptions
Returns
Section titled “Returns”EditorHighlighterRuntime | null
[shikiRequestBinding]()
Section titled “[shikiRequestBinding]()”[shikiRequestBinding](
payload):Promise<ShikiWorkerTransportResult|undefined>
Parameters
Section titled “Parameters”payload
Section titled “payload”ShikiWorkerRequestPayload
Returns
Section titled “Returns”Promise<ShikiWorkerTransportResult | undefined>
awaitIdleFence()
Section titled “awaitIdleFence()”awaitIdleFence():
Promise<void>
Returns
Section titled “Returns”Promise<void>
awaitRuntimeSessionIdle()
Section titled “awaitRuntimeSessionIdle()”awaitRuntimeSessionIdle(
runtimeSessionId):Promise<void>
Parameters
Section titled “Parameters”runtimeSessionId
Section titled “runtimeSessionId”string
Returns
Section titled “Returns”Promise<void>
canUseWorker()
Section titled “canUseWorker()”canUseWorker():
boolean
Returns
Section titled “Returns”boolean
dispose()
Section titled “dispose()”dispose():
Promise<void>
Returns
Section titled “Returns”Promise<void>
disposeDocument()
Section titled “disposeDocument()”disposeDocument(
runtimeSessionId):Promise<void>
Parameters
Section titled “Parameters”runtimeSessionId
Section titled “runtimeSessionId”string
Returns
Section titled “Returns”Promise<void>
inspect()
Section titled “inspect()”inspect():
ShikiWorkerOwnerSnapshot
Returns
Section titled “Returns”inspectRetention()
Section titled “inspectRetention()”inspectRetention():
Promise<ShikiWorkerRetentionSnapshot|null>
Settles existing work and reads the live worker; null means no worker is retained.
Returns
Section titled “Returns”Promise<ShikiWorkerRetentionSnapshot | null>
loadTheme()
Section titled “loadTheme()”loadTheme(
options):Promise<EditorTheme|null|undefined>
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<EditorTheme | null | undefined>
maxTokenizationLineLength()
Section titled “maxTokenizationLineLength()”maxTokenizationLineLength():
number
Returns
Section titled “Returns”number
preload()
Section titled “preload()”preload(
registrations):Promise<void>
Parameters
Section titled “Parameters”registrations
Section titled “registrations”Returns
Section titled “Returns”Promise<void>