Function: database()
Function: database()
Call Signature
function database<TSchema>(config: IDatabaseConfig<TSchema> & {
schema: TSchema;
}): DatabaseRegistration<TSchema> & {
config: IDatabaseConfig<TSchema> & {
schema: TSchema;
};
};Create the database plugin. Omit configuration to load
config/database/schema.ts, or supply a typed schema override.
Type Parameters
| Type Parameter |
|---|
TSchema extends Schema<string> |
Parameters
| Parameter | Type |
|---|---|
config | IDatabaseConfig<TSchema> & { schema: TSchema; } |
Returns
DatabaseRegistration<TSchema> & {
config: IDatabaseConfig<TSchema> & {
schema: TSchema;
};
}
Call Signature
function database<TSchema>(config?: IDatabaseConfig<TSchema>): DatabaseRegistration<TSchema>;Register the database plugin with opinionated defaults and full HTTP CRUD.
By default, setup loads the named schema export from the application's
config/database/schema.ts. Registration itself performs no file or database I/O.
Type Parameters
| Type Parameter | Default type |
|---|---|
TSchema extends Schema<string> | DefaultDatabaseSchema |
Parameters
| Parameter | Type |
|---|---|
config? | IDatabaseConfig<TSchema> |
Returns
DatabaseRegistration<TSchema>