Class BasieStatic

Hierarchy

BasieStatic

Index

Properties

engine

Methods

Properties

Private engine

engine: DatabaseEngine | null = null

Methods

getEngine

getEngine(): DatabaseEngine

- Defined in index.ts:18
Returns the engine currently in use, or throws if there is no engine configured.

Returns DatabaseEngine

mysql

mysql(connection: Connection): void

- Defined in index.ts:47
Configures basie to be used with the specified mysql connection.

Parameters
- connection: Connection
Returns void

postgres

postgres(db: Pool): void

- Defined in index.ts:40
Configures basie to be used with the specified postgres connection pool.

Parameters
- db: Pool
Returns void

sqlite

sqlite(db: sqliteDatabase): void

- Defined in index.ts:33
Configures basie to be used with the specified sqlite database.

Parameters
- db: sqliteDatabase
Returns void

use

use(engine: DatabaseEngine): void

- Defined in index.ts:26
Changes the current database engine to the specified engine.

Parameters
- engine: DatabaseEngine
Returns void

wrap

wrap<InstanceType, Fields>(): (Anonymous function)

- Defined in index.ts:59
Wraps the specified model with basie-specific methods that give it static querying methods. This does not create a table within the database, and instead expects the table to already be present. This function is called a bit weirdly (Basie.wrap<_Model>()(_Model)) to overcome some typescript type system limits and statically typecheck that you're only using valid members.

Type parameters
- InstanceType: BaseModel
- Fields: string
Returns (Anonymous function)

Generated using TypeDoc