InternalPlugins

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugins.d.ts:14

Extends

• Events

Properties

_

_: Record<string, EventsEntry[]>

Defined in: src/obsidian/augmentations/Events.d.ts:5

Inherited from

Events._

---

app

app: App

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugins.d.ts:18

Reference to App

---

config

config: InternalPluginsConfigRecord

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugins.d.ts:22

Mapping of whether an internal plugin is enabled

---

plugins

plugins: InternalPluginNamePluginsMapping

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugins.d.ts:28

Plugin configs for internal plugins

Remark

Prefer usage of getPluginById to access a plugin

Methods

getEnabledPluginById()

getEnabledPluginById<ID>(id): null | InternalPluginNameInstancesMapping[ID]

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugins.d.ts:39

Get an enabled internal plugin by ID

Type Parameters

• ID extends InternalPluginNameType

Parameters

id

ID

ID of the plugin to get

Returns

null | InternalPluginNameInstancesMapping[ID]

---

getEnabledPlugins()

getEnabledPlugins(): InternalPlugin<unknown>[]

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugins.d.ts:43

Get all enabled internal plugins

Returns

InternalPlugin<unknown>[]

---

getPluginById()

getPluginById<ID>(id): null | InternalPluginNamePluginsMapping[ID]

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugins.d.ts:49

Get an internal plugin by ID

Type Parameters

• ID extends InternalPluginNameType

Parameters

id

ID

ID of the plugin to get

Returns

null | InternalPluginNamePluginsMapping[ID]

---

off()

off(name, callback): void

Defined in: obsidian.d.ts:1441

Parameters

name

string

callback

(…data) => unknown

Returns

void

Inherited from

Events.off

---

offref()

offref(ref): void

Defined in: obsidian.d.ts:1445

Parameters

ref

EventRef

Returns

void

Inherited from

Events.offref

---

on()

on(name, callback, ctx?): EventRef

Defined in: obsidian.d.ts:1437

Parameters

name

string

callback

(…data) => unknown

ctx?

any

Returns

EventRef

Inherited from

Events.on

---

trigger()

trigger(name, …data): void

Defined in: obsidian.d.ts:1449

Parameters

name

string

data

…unknown[]

Returns

void

Inherited from

Events.trigger

---

tryTrigger()

tryTrigger(evt, args): void

Defined in: obsidian.d.ts:1453

Parameters

evt

EventRef

args

unknown[]

Returns

void

Inherited from

Events.tryTrigger