Documentation/detritus-client/Structures

Templateclass

Guild Template Structure

On this page

Overview
Constructor1
Properties12
Accessors7
Methods15

Guild Template Structure

import { Structures } from 'detritus-client';

Structures.Template;

Hierarchy

StructureBaseStructureTemplate

16 properties3 methods15 inheritedsrc/structures/template.ts:41

Constructor

new Template

src/structures/template.ts:57

new Template(client: ShardClient, data?: BaseStructureData, isClone?: boolean)

Properties

client

ShardClient

readonly

Inherited from BaseStructure.client

code

string

Default ''

createdAt

Date

creator

User

creatorId

string

Default ''

description

string

Default ''

isDirty

boolean

Default false

name

string

Default ''

serializedSourceGuild?

any

optional

sourceGuildId

string

Default ''

updatedAt

Date

usageCount

number

Default 0

Accessors

createdAtUnix

number

get

isClone

boolean

get

Inherited from BaseStructure.isClone

isUpdated

boolean

get

longUrl

string

get

shardId

number

get

Inherited from BaseStructure.shardId

updatedAtUnix

number

get

url

string

get

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

delete()

async src/structures/template.ts:89

delete(): Promise<any>

difference()

src/structures/basestructure.ts:146

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

fetch()

async src/structures/template.ts:93

fetch(): Promise<Template>

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/template.ts:97

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

mergeValue(key: string, value: any): void

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON