BasesQueryQueue

Unofficial

The file-change queue that streams vault files into a obsidian#QueryController’s query and keeps the results in sync as files are created, modified, renamed, or deleted.

Import:

import type { BasesQueryQueue } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface BasesQueryQueue extends Component

Extends: Component

Constructor

new BasesQueryQueue()

Constructor.

To extract the constructor type, use ExtractConstructor<Component>.

Properties

Property	Type	Description
_children	Component[]	Child Components attached to current component, will be unloaded on unloading parent component. (Inherited from Component)
_events	EventRef[]	Events that are attached to the current component, will be detached on unloading parent component. (Inherited from Component)
_loaded	boolean	Whether the component and its children are loaded. (Inherited from Component)
app	App	The app instance.
dom	QueryController	The owning query controller, to which scan progress and removed results are reported.
queue	unknown	The inner cancellable batch queue that drives the scan, or `null` when the queue is stopped.

Methods

Method	Returns	Description
addChild(component)	T	Adds a child component, loading it if this component is loaded. (Inherited from Component)
load()	void	Load this component and its children. (Inherited from Component)
onFileChanged(file)	void	Re-queues a renamed file or a file whose metadata cache changed.
onFileDeleted(file)	void	Removes a deleted file from the queue and from the results.
onload()	void	Override this to load your component. (Inherited from Component)
onNonMarkdownFileChanged(file)	void	Queues a created or modified non-markdown file.
onunload()	void	Override this to unload your component (Inherited from Component)
register(cb)	void	Registers a callback to be called when unloading. (Inherited from Component)
registerDomEvent(el, type, callback, options?)	void	Registers a DOM event to be detached when unloading. (Inherited from Component)
registerDomEvent(el, type, callback, options?)	void	Registers a DOM event to be detached when unloading (Inherited from Component)
registerDomEvent(el, type, callback, options?)	void	Registers a DOM event to be detached when unloading (Inherited from Component)
registerEvent(eventRef)	void	Registers an event to be detached when unloading. (Inherited from Component)
registerInterval(id)	number	Registers an interval (from setInterval) to be cancelled when unloading. Use `window.setInterval` instead of `setInterval` to avoid TypeScript confusing between NodeJS vs Browser API (Inherited from Component)
registerScopeEvent(keymapEventHandler)	void	Register a scope keymap event handler to be removed on unload. (Inherited from Component)
removeChild(component)	T	Removes a child component, unloading it. (Inherited from Component)
start()	unknown	Starts a new scan, enqueuing every file in the vault.
stop()	void	Stops and cancels the current scan.
unload()	void	Override this to unload your component. (Inherited from Component)

Links to this page:

QueryController