firebase / firebase/firebase-admin-node
Allow generic in onDocumentUpdated, onDocumentCreated, etc...
- Vorherrschende Sprache
- TypeScript
- Sterne
- 1.7k
- Forks
- 419
- Ø Merge
- 3 T. 10 Std.
- Gemergte PRs (30 T.)
- 16
Beschreibung
Problem:
Making a wrapper class where types can be inferred is not possible.
Goal:
```ts
onDocumentUpdated( // note the modified declaration below
`${Col.payments}/{paymentID}`,
handlers.authorizePayment,
);
```
with changes to the declaration such as:
```
// firestore.d.ts
export declare function onDocumentUpdated(document: Document, handler: (event: FirestoreEvent> | undefined, ParamsOf>) => any | Promise): CloudFunction | undefined, ParamsOf>>;
```
Use case:
It will be possible to write things like:
```ts
export type UpdateEvent = FirestoreEvent> | undefined>;
class AuthorizePaymentOnValidatedTrigger implements OnUpdate {
handle(event: UpdateEvent) {
// ...
}
}
```
-----
Currently I'm using a wrapper:
```ts
/// Used to create firebase triggers without having to cast
export abstract class Triggers {
static onDocumentUpdated(path: string, handler: OnUpdateHandler) {
return onDocumentUpdated(path, (event) => handler.handle(event as UpdateEvent));
}
static onDocumentCreated(path: string, handler: OnCreateHandler) {
return onDocumentCreated(path, (event) => handler.handle(event as CreateEvent));
}
static onDocumentDeleted(path: string, handler: OnDeleteHandler) {
return onDocumentDeleted(path, (event) => handler.handle(event as DeleteEvent));
}
}
export type UpdateEvent = FirestoreEvent>>;
export interface OnUpdateHandler {
handle(event: UpdateEvent): Promise;
}
export type CreateEvent = FirestoreEvent>;
export interface OnCreateHandler {
handle(event: CreateEvent): Promise;
}
export type DeleteEvent = FirestoreEvent>;
export interface OnDeleteHandler {
handle(deleted: DeleteEvent): Promise;
}
```
-----
together with #2202 would allow:
```ts
handle(event: UpdateEvent) {
const { before, after } = event.data;
}
```
instead of
```ts
handle(event: UpdateEvent) {
const data = event.data;
if (!data) return;
const before = data.before.data() as Payment;
const after = data.after.data() as Payment;
}
```
Beitragsleitfaden
Rechercherichtung
Beginne mit den Deklarationen onDocumentUpdated, onDocumentCreated und onDocumentDeleted in firestore.d.ts und verwende die vorgeschlagene generische Signatur als Anforderung. Prüfe, wie Dokumentpfade, Handler-Ereignistypen und Dokumentdaten derzeit dargestellt werden; als erledigt gilt die Aufgabe, wenn die Trigger-APIs typisierte generische Event-Handler wie gezeigt ohne Wrapper-Casts unterstützen, zusammen mit der zugehörigen Arbeit in #2202.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- firebase, typescript
- Bereich
- backend-api-design, databases
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100