Ban

Represents a ban in a chatroom.

Extends

Type parameter
`T` extends `EventSubConnection`

1
new Ban<T>(chatbot: ChatBot<T>, data: Ban): Ban<T>

Creates a new instance of the ban.

Parameter	Type	Description
`chatbot`	`ChatBot`<`T`>	The current instance of the chatbot.
`data`	`Ban`	The data of the ban returned from the API.

Base<T>.constructor

Property	Modifier	Type	Description	Inherited from
`chatbot`	`readonly`	`ChatBot`<`T`>	The current instance of the chatbot.	`Base.chatbot`
`moderatorId`	`readonly`	`string`	The Id of the moderator who banned the user.	-
`userId`	`readonly`	`string`	The Id of the user who was banned.	-

1
get chatroomId(): string

The Id of the chatroom where the ban was made.

string

1
get createdAt(): Date

The Date when the ban was created. Returns a JavaScript Date object.

Date

1
get endTime(): null | Date

If the ban is a timeout this will return the end time of the timeout in a JavaScript Date object. If not, it will return a nullish value.

null | Date

1
delete(): Promise<void>

Deletes the ban from the chatroom.

Promise<void>