Skip to content

Add jsdoc to angular FirebaseErrorHandler telemetry API #9404

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
merged 3 commits into from
Dec 2, 2025
Merged

Add jsdoc to angular FirebaseErrorHandler telemetry API #9404

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a94aa78
Add jsdoc to angular FirebaseErrorHandler telemetry API
tonybaroneee Dec 2, 2025
c4b6fff
Add another example to block
tonybaroneee Dec 2, 2025
d49c8c2
Add generated doc files
tonybaroneee Dec 2, 2025
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
24 changes: 24 additions & 0 deletions packages/telemetry/src/angular/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,30 @@ registerTelemetry();

export * from '../public-types';

/**
* A custom ErrorHandler that captures uncaught errors and sends them to Firebase Telemetry.
*
* This should be provided in your application's root module.
*
* @example
* ```typescript
* import { ErrorHandler } from '@angular/core';
* import { FirebaseErrorHandler } from '@firebase/telemetry-angular';
*
* @NgModule({
* // ...
* providers: [
* { provide: ErrorHandler, useClass: FirebaseErrorHandler }
* ],
* // ...
* })
* export class AppModule { }
* ```
*
* @param telemetryOptions - {@link TelemetryOptions} that configure the Telemetry instance.
*
* @public
*/
export class FirebaseErrorHandler implements ErrorHandler {
private readonly router = inject(Router);

Expand Down
Loading