Class Project

Hierarchy

Project

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Project(config: ProjectConfig, client: default): Project

- Defined in src/modules/classes/project.ts:25
Parameters
- config: ProjectConfig
- client: default
Returns Project

Properties

client

client: default

date

date: Date

description

description: string

Optional flags

flags: string[]

guild

guild: Guild

id

id: string

Optional links

links: Link[]

Optional media

media: Media[]

Optional ogImage

ogImage: string

shortDescription

shortDescription: string

status

status: "ongoing" | "past"

submissions

submissions: ProjectSubmissions

title

title: string

url

url: string

Methods

delete

delete(): Promise<void>

- Defined in src/modules/classes/project.ts:141
Delete the project.

Returns Promise<void>

edit

edit(projectConfig: Partial<ProjectConfig>): Promise<Project>

- Defined in src/modules/classes/project.ts:89
Edit the project metadata.

Parameters
- projectConfig: Partial<ProjectConfig>
  
  New project metadata.
Returns Promise<Project>

A promise that resolves to a Project object.

fetchSubmissions

fetchSubmissions(cache?: boolean): Promise<Collection<string, Submission>>

- Defined in src/modules/classes/project.ts:64
Fetch related submissions from the API.

Parameters
- cache: boolean = true
  
  Caches parsed object from response. Default true.
Returns Promise<Collection<string, Submission>>

A promise that resolves to a Collection of submission objects.

toString

toString(): string

- Defined in src/modules/classes/project.ts:156
Returns string

Generated using TypeDoc