Skip to content

docs(storage): add Storage triggers to README table and samples #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Lyokone merged 1 commit into from
Mar 5, 2026
Merged

docs(storage): add Storage triggers to README table and samples #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This package provides a complete Dart implementation of Firebase Cloud Functions
| **Pub/Sub** | ✅ Complete | `onMessagePublished` |
| **Firestore** | ✅ Complete | `onDocumentCreated`, `onDocumentUpdated`, `onDocumentDeleted`, `onDocumentWritten`, `onDocumentCreatedWithAuthContext`, `onDocumentUpdatedWithAuthContext`, `onDocumentDeletedWithAuthContext`, `onDocumentWrittenWithAuthContext` |
| **Realtime Database** | ✅ Complete | `onValueCreated`, `onValueUpdated`, `onValueDeleted`, `onValueWritten` |
| **Storage** | ✅ Complete | `onObjectFinalized`, `onObjectArchived`, `onObjectDeleted`, `onObjectMetadataUpdated` |
| **Firebase Alerts** | ✅ Complete | Crashlytics, Billing, Performance alerts |
| **Identity Platform** | ✅ Complete | `beforeUserCreated`, `beforeUserSignedIn` (+ `beforeEmailSent`, `beforeSmsSent`*) |

Expand Down Expand Up @@ -308,6 +309,50 @@ firebase.database.onValueWritten(
);
```

## Storage Triggers

```dart
// Object finalized (created or overwritten)
firebase.storage.onObjectFinalized(
bucket: 'my-bucket',
(event) async {
final data = event.data;
print('Object finalized: ${data?.name}');
print('Content type: ${data?.contentType}');
print('Size: ${data?.size}');
},
);

// Object archived
firebase.storage.onObjectArchived(
bucket: 'my-bucket',
(event) async {
final data = event.data;
print('Object archived: ${data?.name}');
print('Storage class: ${data?.storageClass}');
},
);

// Object deleted
firebase.storage.onObjectDeleted(
bucket: 'my-bucket',
(event) async {
final data = event.data;
print('Object deleted: ${data?.name}');
},
);

// Object metadata updated
firebase.storage.onObjectMetadataUpdated(
bucket: 'my-bucket',
(event) async {
final data = event.data;
print('Metadata updated: ${data?.name}');
print('Metadata: ${data?.metadata}');
},
);
```

## Firebase Alerts

```dart
Expand Down