DailyNotesPluginInstance

Unofficial

Both Official Unofficial

Both Own Inherited

Plugin instance for daily notes, providing date-based note creation and navigation.

Import:

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

Signature:

export interface DailyNotesPluginInstance extends InternalPluginInstance<DailyNotesPlugin>

Extends: InternalPluginInstance<DailyNotesPlugin>

Properties

	Property	Type	Description
	app	App	Reference to the app.
	defaultOn	true	Whether this plugin is enabled by default.
	description	string	Human-readable description of this plugin. (Inherited from InternalPluginInstance)
	id	string	Unique identifier for this plugin. (Inherited from InternalPluginInstance)
	name	string	Human-readable display name of this plugin. (Inherited from InternalPluginInstance)
	options	DailyNotesOptions	Configuration options for daily notes.
	plugin	DailyNotesPlugin	Reference to the daily notes plugin registration.

Methods

	Method	Returns	Description
	getCurrentFileDateTimestamp()	null | number	Get the date timestamp from the currently open file name, or null if not a daily note.
	getDailyNote(date)	Promise<null | TFile | undefined>	Get or create the daily note for the given date.
	getFormat()	string	Get the configured date format string for daily note filenames.
	gotoNextExisting(timestamp)	Promise<void>	Navigate to the next existing daily note after the given timestamp.
	gotoPreviousExisting(timestamp)	Promise<void>	Navigate to the previous existing daily note before the given timestamp.
	init(app, plugin)	void	Initialize the plugin instance with app and plugin references. (Inherited from InternalPluginInstance)
	iterateDailyNotes(callback)	void	Iterate over all daily notes in the vault, invoking the callback for each.
	onDisable(app, plugin)	void	Called when the plugin is disabled. (Inherited from InternalPluginInstance)
	onEnable(app, plugin)	Promise<void>	Called when the plugin is enabled. (Inherited from InternalPluginInstance)
	onExternalSettingsChange()	Promise<void>	Handle external settings file changes and reload configuration.
	onOpenDailyNote(evt)	Promise<void>	Handle the open daily note command event.
	onUserDisable(app)	void	Called when the user manually disables the plugin. (Inherited from InternalPluginInstance)
	onUserEnable(app)	void	Called when the user manually enables the plugin. (Inherited from InternalPluginInstance)

---

Links to this page:

• DailyNotesPlugin