firebase / firebase/firebase-admin-node

Allow generic in onDocumentUpdated, onDocumentCreated, etc...

Open
#2,203 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
TypeScript
Stars
1.7k
Forks
419
Avg merge
3d 10h
Merged PRs (30d)
16

Description

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;
}
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.