Class: DocClass
Hierarchy​
↳
DocClass
Constructors​
constructor​
• new DocClass(doc, data)
Parameters​
| Name | Type |
|---|---|
doc | Doc |
data | DocumentationClass |
Overrides​
Defined in​
lib/elements/Class.ts:12
Properties​
access​
• access: string
Inherited from​
Defined in​
lib/elements/Element.ts:23
children​
• children: Map<string, DocEvent | DocMethod | DocParam | DocProp>
The children that belong to this element
Inherited from​
Defined in​
lib/elements/Base.ts:16
construct​
• Readonly construct: DocumentationClassConstructor
Defined in​
lib/elements/Class.ts:10
deprecated​
• deprecated: boolean
Inherited from​
Defined in​
lib/elements/Element.ts:22
description​
• description: null | string
Inherited from​
Defined in​
lib/elements/Element.ts:15
doc​
• doc: Doc
Inherited from​
Defined in​
lib/elements/Element.ts:12
docType​
• docType: null | DocTypes
The type of this element
Inherited from​
Defined in​
lib/elements/Base.ts:19
examples​
• examples: null | string[]
Inherited from​
Defined in​
lib/elements/Element.ts:19
extends​
• extends: null | string[][]
Inherited from​
Defined in​
lib/elements/Element.ts:25
implements​
• implements: null | string[][]
Inherited from​
Defined in​
lib/elements/Element.ts:26
meta​
• meta: null | DocumentationClassMeta
Inherited from​
Defined in​
lib/elements/Element.ts:16
name​
• name: null | string
The name of this element
Inherited from​
Defined in​
lib/elements/Base.ts:22
nullable​
• nullable: boolean
Inherited from​
Defined in​
lib/elements/Element.ts:21
parent​
• parent: null | DocElement
Inherited from​
Defined in​
lib/elements/Element.ts:13
returns​
• returns: null | DocumentationReturns | string[][][]
Inherited from​
Defined in​
lib/elements/Element.ts:18
scope​
• scope: null | string
Inherited from​
Defined in​
lib/elements/Element.ts:24
type​
• type: null | string[]
Inherited from​
Defined in​
lib/elements/Element.ts:20
Accessors​
classes​
• get classes(): null | DocClass[]
The stored Classes for this current documentation source
Returns​
null | DocClass[]
Inherited from​
DocElement.classes
Defined in​
lib/elements/Base.ts:78
events​
• get events(): null | DocEvent[]
The stored Events for this current documentation source
Returns​
null | DocEvent[]
Inherited from​
DocElement.events
Defined in​
lib/elements/Base.ts:118
formattedDescription​
• get formattedDescription(): string
Returns the pre-formatted description of this element.
Returns​
string
Inherited from​
DocElement.formattedDescription
Defined in​
lib/elements/Element.ts:81
formattedName​
• get formattedName(): string
Returns the pre-formatted name for this element. This is either the name, or if it is nullish then an empty string.
Returns​
string
Inherited from​
DocElement.formattedName
Defined in​
lib/elements/Element.ts:74
interfaces​
• get interfaces(): null | DocInterface[]
The stored Interfaces for this current documentation source
Returns​
null | DocInterface[]
Inherited from​
DocElement.interfaces
Defined in​
lib/elements/Base.ts:94
link​
• get link(): string
Returns the pre-formatted link of this element.
By default this will be returned as a regular markdown masked link.
You can further customize this by setting {@link Doc.globalOptions.escapeMarkdownLinks}
which will wrap the links with <...> so sending the link through a Webhook or Interaction reply
will not embed that link in the chat.
Returns​
string
Inherited from​
DocElement.link
Defined in​
lib/elements/Element.ts:98
methods​
• get methods(): null | DocMethod[]
The stored Methods for this current documentation source
Returns​
null | DocMethod[]
Inherited from​
DocElement.methods
Defined in​
lib/elements/Base.ts:110
params​
• get params(): null | DocParam[]
The stored Params for this current documentation source
Returns​
null | DocParam[]
Inherited from​
DocElement.params
Defined in​
lib/elements/Base.ts:126
props​
• get props(): null | DocProp[]
The stored Props for this current documentation source
Returns​
null | DocProp[]
Inherited from​
DocElement.props
Defined in​
lib/elements/Base.ts:102
sourceURL​
• get sourceURL(): null | string
Returns the url to the source code for this element.
Returns​
null | string
Inherited from​
DocElement.sourceURL
Defined in​
lib/elements/Element.ts:63
static​
• get static(): boolean
Returns whether this element is static or not.
Returns​
boolean
Inherited from​
DocElement.static
Defined in​
lib/elements/Element.ts:109
typedefs​
• get typedefs(): null | DocTypedef[]
The stored Typedefs for this current documentation source
Returns​
null | DocTypedef[]
Inherited from​
DocElement.typedefs
Defined in​
lib/elements/Base.ts:86
url​
• get url(): null | string
Returns the URL to this element on the discord.js documentation.
Returns​
null | string
Inherited from​
DocElement.url
Defined in​
lib/elements/Element.ts:52
Methods​
toJSON​
â–¸ toJSON(): ElementJSON
Overrides what should be returned when calling JSON.stringify on this class
Returns​
Inherited from​
Defined in​
lib/elements/Element.ts:135