Classpluginsv0.6.1

KpgService

Base class for KyselyPg services.

Provides a small, typed shim around the shared Kysely instance and ensures that subclasses have been decorated with @RegisterKpgService@RegisterKpgService.

abstract class KpgService<
    Database extends object,
    TTable extends LiteralUnion<keyof Database, string>
>

abstract class KpgService<
    Database extends object,
    TTable extends LiteralUnion<keyof Database, string>
>

\@RegisterKpgService('users')
export class UsersService extends KpgService<ImportedDatabaseInterface, 'users'> {
  public async findById(id: string) {
    return this.entity
      .selectFrom(this.table)
      .selectAll().where('id', '=', id)
      .executeTakeFirst();
  }
}

// Usage inside handlers:
const user = await this.core.db.services.users.findById('abc');

\@RegisterKpgService('users')
export class UsersService extends KpgService<ImportedDatabaseInterface, 'users'> {
  public async findById(id: string) {
    return this.entity
      .selectFrom(this.table)
      .selectAll().where('id', '=', id)
      .executeTakeFirst();
  }
}

// Usage inside handlers:
const user = await this.core.db.services.users.findById('abc');

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the KpgServiceKpgService class

KpgService(
    kysely: KyselyPg<Database>,
    core: Core
)

KpgService(
    kysely: KyselyPg<Database>,
    core: Core
)

Showing members with Protected visibility and higher.

Database

The database shape used by Kysely (tables as keys).

Database extends object

Database extends object

TTable

The specific table key from DatabaseDatabase this service works with.

TTable extends LiteralUnion<keyof Database, string>

TTable extends LiteralUnion<keyof Database, string>

core

protected readonly core: Core

protected readonly core: Core

accessor

db

Shared Kysely instance used to interact with the Postgres database.

public get db(): Kysely<Database>

public get db(): Kysely<Database>

kysely

protected readonly kysely: KyselyPg<Database>

protected readonly kysely: KyselyPg<Database>

table

public readonly table: TTable

public readonly table: TTable