electricCollectionOptions
Funktion: electricCollectionOptions()
function electricCollectionOptions<TExplicit, TSchema, TFallback>(config): object
function electricCollectionOptions<TExplicit, TSchema, TFallback>(config): object
Definiert in: packages/electric-db-collection/src/electric.ts:285
Erstellt Electric Collection-Optionen zur Verwendung mit einer Standard Collection
Typparameter
• TExplicit erweitert Row<unknown> = Row<unknown>
Der explizite Typ der Elemente in der Collection (höchste Priorität)
• TSchema erweitert StandardSchemaV1<unknown, unknown> = never
Der Schema-Typ für Validierung und Typableitung (zweite Priorität)
• TFallback erweitert Row<unknown> = Row<unknown>
Der Fallback-Typ, wenn kein expliziter Typ oder kein Schema-Typ angegeben wird
Parameter
config
ElectricCollectionConfig<TExplicit, TSchema, TFallback>
Konfigurationsoptionen für die Electric Collection
Gibt zurück
Objekt
Collection-Optionen mit Hilfsprogrammen
getKey()
getKey: (item) => string | number;
getKey: (item) => string | number;
Parameter
item
ResolveType
Gibt zurück
string | number
id?
optional id: string;
optional id: string;
Alle Standard-Collection-Konfigurationseigenschaften
onDelete
onDelete:
| undefined
| (params) => Promise<{
txid: number | number[];
}> = wrappedOnDelete;
onDelete:
| undefined
| (params) => Promise<{
txid: number | number[];
}> = wrappedOnDelete;
onInsert
onInsert:
| undefined
| (params) => Promise<{
txid: number | number[];
}> = wrappedOnInsert;
onInsert:
| undefined
| (params) => Promise<{
txid: number | number[];
}> = wrappedOnInsert;
onUpdate
onUpdate:
| undefined
| (params) => Promise<{
txid: number | number[];
}> = wrappedOnUpdate;
onUpdate:
| undefined
| (params) => Promise<{
txid: number | number[];
}> = wrappedOnUpdate;
schema?
optional schema: TSchema;
optional schema: TSchema;
sync
sync: SyncConfig<ResolveType<TExplicit, TSchema, TFallback>, string | number>;
sync: SyncConfig<ResolveType<TExplicit, TSchema, TFallback>, string | number>;
utils
utils: object;
utils: object;
utils.awaitTxId
awaitTxId: AwaitTxIdFn;
awaitTxId: AwaitTxIdFn;
Bytes abonnieren
Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.
Bytes abonnieren
Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.