LocalOnlyCollectionConfig

Interface: LocalOnlyCollectionConfig<TExplicit, TSchema, TFallback, TKey>

Definiert in: packages/db/src/local-only.ts:27

Konfigurationsinterface für lokale Sammlungsoptionen

Bemerkungen

Typauflösung folgt einer Prioritätsreihenfolge

  1. Wenn Sie einen expliziten Typ über einen generischen Parameter angeben, wird dieser verwendet
  2. Wenn kein expliziter Typ, aber ein Schema angegeben wird, wird der Ausgabetyp des Schemas abgeleitet
  3. Wenn weder ein expliziter Typ noch ein Schema angegeben wird, wird der Fallback-Typ verwendet

Sie sollten ENTWEDER einen expliziten Typ ODER ein Schema angeben, aber nicht beides, da dies zu Konflikten führen würde.

Typparameter

TExplicit = unknown

Der explizite Typ der Elemente in der Collection (höchste Priorität)

TSchema erweitert StandardSchemaV1 = never

Der Schema-Typ für Validierung und Typableitung (zweite Priorität)

TFallback erbt von Record<string, unknown> = Record<string, unknown>

Der Fallback-Typ, wenn kein expliziter Typ oder kein Schema-Typ angegeben wird

TKey erweitert string | number = string | number

Der Typ des Schlüssels, der von getKey zurückgegeben wird

Eigenschaften

getKey()

ts
getKey: (item) => TKey;
getKey: (item) => TKey;

Definiert in: packages/db/src/local-only.ts:38

Parameter

item

ResolveType<TExplicit, TSchema, TFallback>

Gibt zurück

TKey


id?

ts
optional id: string;
optional id: string;

Definiert in: packages/db/src/local-only.ts:36

Standard-Eigenschaften der Sammlungskonfiguration


initialData?

ts
optional initialData: ResolveType<TExplicit, TSchema, TFallback>[];
optional initialData: ResolveType<TExplicit, TSchema, TFallback>[];

Definiert in: packages/db/src/local-only.ts:44

Optionale anfängliche Daten, mit denen die Sammlung bei der Erstellung gefüllt werden soll. Diese Daten werden während des anfänglichen Synchronisierungsprozesses angewendet.


onDelete()?

ts
optional onDelete: (params) => Promise<any>;
optional onDelete: (params) => Promise<any>;

Definiert in: packages/db/src/local-only.ts:77

Optionale asynchrone Handler-Funktion, die nach einer Löschoperation aufgerufen wird.

Parameter

params

DeleteMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>, TKey, LocalOnlyCollectionUtils>

Objekt, das Transaktions- und Collection-Informationen enthält

Gibt zurück

Promise<any>

Promise, das zu einem beliebigen Wert aufgelöst wird


onInsert()?

ts
optional onInsert: (params) => Promise<any>;
optional onInsert: (params) => Promise<any>;

Definiert in: packages/db/src/local-only.ts:51

Optionale asynchrone Handler-Funktion, die nach einer Einfügeoperation aufgerufen wird.

Parameter

params

InsertMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>, TKey, LocalOnlyCollectionUtils>

Objekt, das Transaktions- und Collection-Informationen enthält

Gibt zurück

Promise<any>

Promise, das zu einem beliebigen Wert aufgelöst wird


onUpdate()?

ts
optional onUpdate: (params) => Promise<any>;
optional onUpdate: (params) => Promise<any>;

Definiert in: packages/db/src/local-only.ts:64

Optionale asynchrone Handler-Funktion, die nach einer Aktualisierungsoperation aufgerufen wird.

Parameter

params

UpdateMutationFnParams<ResolveType<TExplicit, TSchema, TFallback>, TKey, LocalOnlyCollectionUtils>

Objekt, das Transaktions- und Collection-Informationen enthält

Gibt zurück

Promise<any>

Promise, das zu einem beliebigen Wert aufgelöst wird


schema?

ts
optional schema: TSchema;
optional schema: TSchema;

Definiert in: packages/db/src/local-only.ts:37

Unsere Partner
Code Rabbit
Electric
Prisma
Bytes abonnieren

Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.

Bytes

Kein Spam. Jederzeit kündbar.

Bytes abonnieren

Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.

Bytes

Kein Spam. Jederzeit kündbar.