Overview / Plugin

Plugin<T, S>

Type Parameters

Type Parameter	Default type
T extends Record<string, z.ZodType>	Record<string, z.ZodType>
S extends z.infer<z.ZodObject<T>>	z.infer<z.ZodObject<T>>

Properties

Property	Modifier	Type	Default value
forms	public	Form<{}>[]	[]
path	public	string	undefined
tools	public	Tool[]	[]

Accessors

active

Get Signature

get active(): boolean

Returns

boolean

Set Signature

set active(active): void

Parameters

Parameter	Type
active	boolean

Returns

void

---

hooks

Get Signature

get hooks(): Hook[]

Returns

Hook[]

---

id

Get Signature

get id(): string

Returns

string

---

info

Get Signature

get info(): object

Returns

object

Name	Type	Default value
active	boolean	-
forms	object[]	-
hooks	object[]	-
id	string	-
manifest	object	-
manifest.authorName	string	-
manifest.authorUrl?	string	-
manifest.description	string	-
manifest.name	string	-
manifest.pluginUrl?	string	-
manifest.tags	string[]	-
manifest.thumb?	string	-
manifest.version	string	-
tools	object[]	-
upgradable	boolean	false

---

manifest

Get Signature

get manifest(): object

Returns

object

Name	Type
authorName	string
authorUrl?	string
description	string
name	string
pluginUrl?	string
tags	string[]
thumb?	string
version	string

---

reloading

Get Signature

get reloading(): boolean

Returns

boolean

---

schema

Get Signature

get schema(): ZodObject<T, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, any>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>

Returns

ZodObject<T, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, any>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>

---

settings

Get Signature

get settings(): S

Returns

S

Set Signature

set settings(settings): void

Parameters

Parameter	Type
settings	S

Returns

void

Methods

reload()

reload(): Promise<void>

Returns

Promise<void>

---

remove()

remove(): Promise<void>

Asynchronously removes the current plugin. This method performs the following actions:

1. Triggers the 'removed' event.
2. Revokes all object URLs stored.
3. If any dependencies are found in the plugin's package.json file, they are uninstalled.
4. Deletes the plugin's directory and its contents.

Returns

Promise<void>

---

triggerEvent()

triggerEvent(event): void

Triggers the specified event.

Parameters

Parameter	Type	Description
event	keyof PluginEvents	The name of the event to trigger.

Returns

void

---

new()

static new(path): Promise<Plugin<{}>>

Parameters

Parameter	Type
path	string

Returns

Promise<Plugin<{}>>