LogoAntiRaid

@antiraid-core/events

API reference for @antiraid-core/events

@antiraid-core/events

Types

GetSettingsEvent

Get settings event

Raw Type
--- Get settings event
type GetSettingsEvent = {
	author: discord.Snowflake
}
PropTypeDescription
author
-

SettingExecuteEvent

Setting execute event

Raw Type
--- Setting execute event
type SettingExecuteEvent = {
	--- ID of the setting being executed
	id: string,

	--- The author of the event
	author: discord.Snowflake,

	--- The operation being performed on the setting
	op: string,

	--- The fields
	fields: {
		[string]: any
	}
}
PropTypeDescription
id
ID of the setting being executed
author
The author of the event
op
The operation being performed on the setting
fields
{[string]: any}
The fields

ExternalKeyUpdateEventData

Data sent when a key is updated externally (through the web dashboard etc)

NOTE: To avoid recursive template executions, this does not trigger on in-template

key-value updates

Raw Type
--- Data sent when a key is updated externally (through the web dashboard etc)
---
--- NOTE: To avoid recursive template executions, this does not trigger on in-template
--- key-value updates
type ExternalKeyUpdateEventData = {
	key_modified: string,

	author: discord.Snowflake,

	action: "create" | "update" | "delete"
}
PropTypeDescription
key_modified
-
author
-
action
('create' | 'update' | 'delete')
-

KeyExpiryEvent

Data sent when a key expires.

Raw Type
--- Data sent when a key expires.
type KeyExpiryEvent = {
	id: string,

	key: string,

	scopes: {string}
}
PropTypeDescription
id
-
key
-
scopes
-

KeyResumeEvent

Data sent when a key is resumed.

A key is resumed when it is set with the `resume` flag and the template is reloaded or the worker process restarted.

Raw Type
--- Data sent when a key is resumed.
---
--- A key is resumed when it is set with the \`resume\` flag and the template is reloaded or the worker process restarted.
type KeyResumeEvent = {
	id: string,

	key: string,

	scopes: {string}
}
PropTypeDescription
id
-
key
-
scopes
-

Last updated on