Class: AddonAPI

Defined in: src/betterdiscord/api/addonapi.ts:7

AddonAPI is a utility class for working with plugins and themes. Instances are accessible through the BdApi.

Accessors

folder

Get Signature

get folder(): string;

Defined in: src/betterdiscord/api/addonapi.ts:16

The path to the addon folder.

Returns

string

Methods

disable()

disable(idOrAddon: string): 
  | void
  | AddonError<{
  message?: string;
  stack?: string;
}>;

Defined in: src/betterdiscord/api/addonapi.ts:35

Disables the given addon.

Parameters

Parameter	Type
idOrAddon	string

Returns

| void | AddonError<{ message?: string; stack?: string; }>

---

enable()

enable(idOrAddon: string): 
  | void
  | AddonError<{
  message?: string;
  stack?: string;
}>;

Defined in: src/betterdiscord/api/addonapi.ts:29

Enables the given addon.

Parameters

Parameter	Type
idOrAddon	string

Returns

| void | AddonError<{ message?: string; stack?: string; }>

---

get()

get(idOrFile: string): Addon | undefined;

Defined in: src/betterdiscord/api/addonapi.ts:54

Gets a particular addon.

Parameters

Parameter	Type	Description
idOrFile	string	Addon ID or filename

Returns

Addon | undefined

Addon instance

---

getAll()

getAll(): (Addon | undefined)[];

Defined in: src/betterdiscord/api/addonapi.ts:60

Gets all addons of this type.

Returns

(Addon | undefined)[]

Array of all addon instances

---

isEnabled()

isEnabled(idOrFile: string): boolean;

Defined in: src/betterdiscord/api/addonapi.ts:23

Determines if a particular addon is enabled.

Parameters

Parameter	Type	Description
idOrFile	string	Addon ID or filename

Returns

boolean

---

reload()

reload(idOrFileOrAddon: string): 
  | false
  | void
  | AddonError<{
  message?: string;
  stack?: string;
}>;

Defined in: src/betterdiscord/api/addonapi.ts:47

Reloads if a particular addon is enabled.

Parameters

Parameter	Type
idOrFileOrAddon	string

Returns

| false | void | AddonError<{ message?: string; stack?: string; }>

---

toggle()

toggle(idOrAddon: string): void;

Defined in: src/betterdiscord/api/addonapi.ts:41

Toggles if a particular addon is enabled.

Parameters

Parameter	Type
idOrAddon	string

Returns

void