hoshii / Exports / Doc

Doc

Represents a doc

Hierarchy

• Base<number>

  ↳ Doc

Table of contents

Constructors

• constructor

Properties

• channelID
• client
• content
• createdAt
• createdBy
• id
• mentions
• serverID
• title
• updatedAt
• updatedBy

Accessors

• member

Methods

• delete
• edit
• toJSON
• update

Constructors

constructor

• new Doc(data, client)

Creates a new Doc

Parameters

Name	Type	Description
data	RawDoc	The raw data of the doc
client	Client	The client

Overrides

Base.constructor

Defined in

lib/structures/Doc.ts:95

Properties

channelID

• channelID: string

The ID of the channel the doc is in

Defined in

lib/structures/Doc.ts:48

---

client

• client: Client

The bot client

Inherited from

Base.client

Defined in

lib/structures/Base.ts:13

---

content

• content: string

The content of the doc

Defined in

lib/structures/Doc.ts:53

---

createdAt

• createdAt: Date

The date the doc was created at

Defined in

lib/structures/Doc.ts:58

---

createdBy

• createdBy: string

The ID of the user who created the doc

Defined in

lib/structures/Doc.ts:63

---

id

• id: number

The ID of the item

Inherited from

Base.id

Defined in

lib/structures/Base.ts:16

---

mentions

• mentions: Mentions

The mentions in the doc

Defined in

lib/structures/Doc.ts:68

---

serverID

• serverID: string

The ID of the server the doc is in

Defined in

lib/structures/Doc.ts:73

---

title

• title: string

The title of the doc

Defined in

lib/structures/Doc.ts:78

---

updatedAt

• updatedAt: Date

The date the doc was last updated

Defined in

lib/structures/Doc.ts:83

---

updatedBy

• updatedBy: string

The ID of the user who last updated the doc

Defined in

lib/structures/Doc.ts:88

Accessors

member

• get member(): ServerMember | Promise<ServerMember>

The server member who created (or updated) the doc

Returns

ServerMember | Promise<ServerMember>

Defined in

lib/structures/Doc.ts:113

Methods

delete

▸ delete(): Promise<void>

Delete the doc

Returns

Promise<void>

Defined in

lib/structures/Doc.ts:129

---

edit

▸ edit(options): Promise<Doc>

Edit the doc

Parameters

Name	Type	Description
options	DocOptions	The options to edit the doc with

Returns

Promise<Doc>

Defined in

lib/structures/Doc.ts:138

---

toJSON

▸ toJSON(): DocData

Returns the JSON representation of the item

Returns

DocData

Overrides

Base.toJSON

Defined in

lib/structures/Doc.ts:142

---

update

▸ Protected update(data): void

Parameters

Name	Type
data	RawDoc

Returns

void

Overrides

Base.update

Defined in

lib/structures/Doc.ts:157