kuito.
Loslegen

Table

A table the migrations made, and the schema each of its rows matches.

Typ

Verwendung

Reuse a filter when querying a typed table.

tsx
// Reuse a filter when querying a typed table.
import { db, type Comparison, type Table } from 'kuito';

type Product = { id: string; price: number };
export function affordableProducts(products: Table<Product>) {
  const price: Comparison<number> = { gte: 0, lte: 50 };
  return db.query(products, { where: { price }, orderBy: { price: 'asc' } });
}

Typdeklaration

ts
export interface Table<T> {
  readonly name: string;
  readonly schema: Schema<T>;
  /** Inserts every row in one transaction: all of them land, or none. */
  insert(rows: T | readonly T[]): Promise<void>;
  update(where: Where<T>, changes: Partial<T>): Promise<void>;
  /** Deletes the rows `where` matches: `{}` matches every row. */
  delete(where: Where<T>): Promise<void>;
}

Mitglieder 5

NameTypErforderlichBeschreibung
nameschreibgeschütztstringJa—
schemaschreibgeschütztSchema<T>Ja—
insert(rows: T | readonly T[]) => Promise<void>JaInserts every row in one transaction: all of them land, or none.
update(where: Where<T>, changes: Partial<T>) => Promise<void>Ja—
delete(where: Where<T>) => Promise<void>JaDeletes the rows where matches: {} matches every row.
insert — Methodensignaturen

Signaturen

ts
(rows: T | readonly T[]): Promise<void>

Parameter

NameTypErforderlichBeschreibung
rowsT | readonly T[]Ja—

Rückgabe

Promise<void>

update — Methodensignaturen

Signaturen

ts
(where: Where<T>, changes: Partial<T>): Promise<void>

Parameter

NameTypErforderlichBeschreibung
whereWhere<T>Ja—
changesPartial<T>Ja—

Rückgabe

Promise<void>

delete — Methodensignaturen

Signaturen

ts
(where: Where<T>): Promise<void>

Parameter

NameTypErforderlichBeschreibung
whereWhere<T>Ja—

Rückgabe

Promise<void>

Generiert aus den öffentlichen TypeScript-Deklarationen: Signaturen, Props und Standardwerte stammen aus der geprüften Quelle, Beschreibungen aus deren JSDoc. Kein Standardwert ist erfunden.