📄Doc

Doc is component coming from a 'docs' channel.

Properties

Property
Description
Type

data

Raw data

Object

client

Client

id

ID of the doc

Number

guildID

Guild/server id

String

channelID

ID of the 'docs' channel.

String

title

Doc title/name

String

name

Doc title/name

String

content

Content of the doc

String

mentions

Doc mentions

_createdAt

Timestamp (unix epoch time) of the doc's creation.

Number|null

memberID

ID of the member who created the doc.

String

_updatedAt

Timestamp (unix epoch time) of when the doc was updated. (if updated)

Number|null

updatedBy

ID of the member who updated the doc. (if updated)

String

member

Member that made emit the event.

createdAt

String representation of the _createdAt timestamp.

Date|null

updatedAt

String representation of the _updatedAt timestamp.

Date|null

Constructor

new Doc(rawData, client)
Properties
Description
Type
Required?

rawData

raw data received from ws and converted to JSON

Object

true

client

Client

true

Do not use this constructor unless you know what you're doing. This constructor is used to return you rawdata into component.

Methods

edit(options)

Edit the doc.

Properties
Description
Type
Required?

options

Edit options

Object

true

options.title?

New doc title

String

false

options.content?

New doc content

String

false

Returns: Promise<Doc>

delete()

Delete the doc.

Returns: Promise<void>

Last updated