Class Database

Hierarchy (view full)

GiveawaysDatabaseManager
- Database

Index

Constructors

Properties

database entityManager type? entities type

Methods

getDB init delete find get getAll set wipe

Constructors

constructor

new Database(emitter): Database
Parameters
- emitter: TypedEmitter<TransformEvents<IGiveawayEvents>>
Returns Database
Overrides GiveawaysDatabaseManager.constructor
- Defined in src/structures/Database.ts:30

Properties

database

database: string = "giveaways.db"

entityManager

entityManager: {
    mongodb: typeof MongoGiveaway[];
    mysql: typeof Giveaway[];
    postgres: typeof Giveaway[];
    sqlite: typeof Giveaway[];
} = ...

`Optional`type

type?:
    | "mysql"
    | "postgres"
    | "mongodb"
    | "better-sqlite3"
    | "sqlite"

`Static`entities

entities: {
Giveaway: AnyGiveaway;
}

`Static`type

type:
    | "mysql"
    | "postgres"
    | "mongodb"
    | "better-sqlite3"
    | "sqlite"

Methods

`Protected`getDB

getDB(): Promise<DataSource>
Returns Promise<DataSource>
Inherited from GiveawaysDatabaseManager.getDB
- Defined in node_modules/@tryforge/forge.db/dist/util/databaseManager.d.ts:15

init

init(): Promise<void>
Returns Promise<void>
- Defined in src/structures/Database.ts:39

`Static`delete

delete(id): Promise<DeleteResult>
Deletes an existing giveaway from the database.
Parameters
- id: string
  The id of the giveaway to delete.
Returns Promise<DeleteResult>
- Defined in src/structures/Database.ts:91

`Static`find

find(data?, amount?): Promise<Giveaway[]>
Finds existing giveaways matching the provided data.
Parameters
- Optionaldata: Partial<Omit<IGiveaway, "entries" | "winners" | "previousWinners">>
  The data to use for searching.
- Optionalamount: number
  The amount of results to return.
Returns Promise<Giveaway[]>
- Defined in src/structures/Database.ts:68

`Static`get

get(id): Promise<null | Giveaway>
Gets an existing giveaway.
Parameters
- id: string
  The id of the giveaway to get.
Returns Promise<null | Giveaway>
- Defined in src/structures/Database.ts:50

`Static`getAll

getAll(): Promise<Giveaway[]>
Gets all existing giveaways.

Returns Promise<Giveaway[]>
- Defined in src/structures/Database.ts:58

`Static`set

set(data): Promise<void>
Saves a giveaway in the database.
Parameters
- data: Giveaway | MongoGiveaway
  The giveaway data to save.
Returns Promise<void>
- Defined in src/structures/Database.ts:76

`Static`wipe

wipe(): Promise<void>
Wipes the entire database.

Returns Promise<void>
- Defined in src/structures/Database.ts:99