Class GuildProjects

Hierarchy

GuildProjects

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GuildProjects(client: default, guild: Guild, entries?: null | readonly readonly [string, Project][]): GuildProjects

- Defined in src/modules/collections/guildProjects.ts:15
Parameters
- client: default
- guild: Guild
- Optional entries: null | readonly readonly [string, Project][]
Returns GuildProjects

Properties

cache

cache: Collection<string, Project>

client

client: default

guild

guild: Guild

Methods

create

create(projectConfig: Omit<ProjectConfig, keyof OmitConfig>, cache?: boolean): Promise<Project>

- Defined in src/modules/collections/guildProjects.ts:55
Create a new project.

Parameters
- projectConfig: Omit<ProjectConfig, keyof OmitConfig>
  
  Project metadata.
- cache: boolean = true
  
  Caches parsed object from response. Default true.
Returns Promise<Project>

A promise that resolves to a Project object.

resolve

resolve(project: ProjectResolvable): undefined | Project

- Defined in src/modules/collections/guildProjects.ts:32
Resolve a resolvable to a matching object.

Parameters
- project: ProjectResolvable
  
  Project resolvable to resolve.
Returns undefined | Project

Project object or undefined.

resolveID

resolveID(project: ProjectResolvable): undefined | string

- Defined in src/modules/collections/guildProjects.ts:42
Resolve a resolvable to a matching object ID.

Parameters
- project: ProjectResolvable
  
  Project resolvable to resolve.
Returns undefined | string

Project ID or undefined.

Generated using TypeDoc