Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## API Report File for "@firebase/telemetry-angular"
## API Report File for "@firebase/crashlytics-angular"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

Expand All @@ -8,23 +8,23 @@ import { ErrorHandler } from '@angular/core';
import { FirebaseApp } from '@firebase/app';

// @public
export class FirebaseErrorHandler implements ErrorHandler {
constructor(app: FirebaseApp, telemetryOptions?: TelemetryOptions);
// (undocumented)
handleError(error: unknown): void;
}

// @public
export interface Telemetry {
export interface Crashlytics {
app: FirebaseApp;
}

// @public
export interface TelemetryOptions {
export interface CrashlyticsOptions {
appVersion?: string;
endpointUrl?: string;
}

// @public
export class FirebaseErrorHandler implements ErrorHandler {
constructor(app: FirebaseApp, crashlyticsOptions?: CrashlyticsOptions);
// (undocumented)
handleError(error: unknown): void;
}


// (No @packageDocumentation comment for this package)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## API Report File for "@firebase/telemetry-react"
## API Report File for "@firebase/crashlytics-react"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
Expand All @@ -7,22 +7,22 @@
import { FirebaseApp } from '@firebase/app';

// @public
export function FirebaseTelemetry({ firebaseApp, telemetryOptions }: {
firebaseApp: FirebaseApp;
telemetryOptions?: TelemetryOptions;
}): null;

// @public
export interface Telemetry {
export interface Crashlytics {
app: FirebaseApp;
}

// @public
export interface TelemetryOptions {
export interface CrashlyticsOptions {
appVersion?: string;
endpointUrl?: string;
}

// @public
export function FirebaseCrashlytics({ firebaseApp, crashlyticsOptions }: {
firebaseApp: FirebaseApp;
crashlyticsOptions?: CrashlyticsOptions;
}): null;


// (No @packageDocumentation comment for this package)

Expand Down
39 changes: 39 additions & 0 deletions common/api-review/crashlytics.api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## API Report File for "@firebase/crashlytics"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { AnyValueMap } from '@opentelemetry/api-logs';
import { FirebaseApp } from '@firebase/app';
import { Instrumentation } from 'next';

// @public
export function captureError(crashlytics: Crashlytics, error: unknown, attributes?: AnyValueMap): void;

// @public
export interface Crashlytics {
app: FirebaseApp;
}

// @public
export interface CrashlyticsOptions {
appVersion?: string;
endpointUrl?: string;
}

// @public
export function flush(crashlytics: Crashlytics): Promise<void>;

// @public
export function getCrashlytics(app?: FirebaseApp, options?: CrashlyticsOptions): Crashlytics;

export { Instrumentation }

// @public
export function nextOnRequestError(crashlyticsOptions?: CrashlyticsOptions): Instrumentation.onRequestError;


// (No @packageDocumentation comment for this package)

```
39 changes: 0 additions & 39 deletions common/api-review/telemetry.api.md

This file was deleted.

46 changes: 23 additions & 23 deletions docs-devsite/_toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,29 @@ toc:
path: /docs/reference/js/auth.userinfo.md
- title: UserMetadata
path: /docs/reference/js/auth.usermetadata.md
- title: crashlytics
path: /docs/reference/js/crashlytics_.md
section:
- title: Crashlytics
path: /docs/reference/js/crashlytics_.crashlytics.md
- title: CrashlyticsOptions
path: /docs/reference/js/crashlytics_.crashlyticsoptions.md
- title: crashlytics/angular
path: /docs/reference/js/crashlytics_angular.md
section:
- title: Crashlytics
path: /docs/reference/js/crashlytics_angular.crashlytics.md
- title: CrashlyticsOptions
path: /docs/reference/js/crashlytics_angular.crashlyticsoptions.md
- title: FirebaseErrorHandler
path: /docs/reference/js/crashlytics_angular.firebaseerrorhandler.md
- title: crashlytics/react
path: /docs/reference/js/crashlytics_react.md
section:
- title: Crashlytics
path: /docs/reference/js/crashlytics_react.crashlytics.md
- title: CrashlyticsOptions
path: /docs/reference/js/crashlytics_react.crashlyticsoptions.md
- title: database
path: /docs/reference/js/database.md
section:
Expand Down Expand Up @@ -702,26 +725,3 @@ toc:
path: /docs/reference/js/storage.uploadtask.md
- title: UploadTaskSnapshot
path: /docs/reference/js/storage.uploadtasksnapshot.md
- title: telemetry
path: /docs/reference/js/telemetry_.md
section:
- title: Telemetry
path: /docs/reference/js/telemetry_.telemetry.md
- title: TelemetryOptions
path: /docs/reference/js/telemetry_.telemetryoptions.md
- title: telemetry/angular
path: /docs/reference/js/telemetry_angular.md
section:
- title: FirebaseErrorHandler
path: /docs/reference/js/telemetry_angular.firebaseerrorhandler.md
- title: Telemetry
path: /docs/reference/js/telemetry_angular.telemetry.md
- title: TelemetryOptions
path: /docs/reference/js/telemetry_angular.telemetryoptions.md
- title: telemetry/react
path: /docs/reference/js/telemetry_react.md
section:
- title: Telemetry
path: /docs/reference/js/telemetry_react.telemetry.md
- title: TelemetryOptions
path: /docs/reference/js/telemetry_react.telemetryoptions.md
8 changes: 4 additions & 4 deletions docs-devsite/telemetry.md → docs-devsite/crashlytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# telemetry package
# crashlytics package

| Entry Point | Description |
| --- | --- |
| [/](./telemetry_.md#@firebase/telemetry) | |
| [/angular](./telemetry_angular.md#@firebase/telemetry/angular) | |
| [/react](./telemetry_react.md#@firebase/telemetry/react) | |
| [/](./crashlytics_.md#@firebase/crashlytics) | |
| [/angular](./crashlytics_angular.md#@firebase/crashlytics/angular) | |
| [/react](./crashlytics_react.md#@firebase/crashlytics/react) | |

37 changes: 37 additions & 0 deletions docs-devsite/crashlytics_.crashlytics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# Crashlytics interface
An instance of the Firebase Crashlytics SDK.

Do not create this instance directly. Instead, use [getCrashlytics()](./crashlytics_.md#getcrashlytics_a9d22a1)<!-- -->.

<b>Signature:</b>

```typescript
export interface Crashlytics
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [app](./crashlytics_.crashlytics.md#crashlyticsapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Crashlytics](./crashlytics_.crashlytics.md#crashlytics_interface) instance is associated with. |

## Crashlytics.app

The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Crashlytics](./crashlytics_.crashlytics.md#crashlytics_interface) instance is associated with.

<b>Signature:</b>

```typescript
app: FirebaseApp;
```
46 changes: 46 additions & 0 deletions docs-devsite/crashlytics_.crashlyticsoptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# CrashlyticsOptions interface
Options for initializing the Crashlytics service using [getCrashlytics()](./crashlytics_.md#getcrashlytics_a9d22a1)<!-- -->.

<b>Signature:</b>

```typescript
export interface CrashlyticsOptions
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [appVersion](./crashlytics_.crashlyticsoptions.md#crashlyticsoptionsappversion) | string | The version of the application. This should be a unique string that identifies the snapshot of code to be deployed, such as "1.0.2". If not specified, other default locations will be checked for an identifier. Setting a value here takes precedence over any other values. |
| [endpointUrl](./crashlytics_.crashlyticsoptions.md#crashlyticsoptionsendpointurl) | string | The URL for the endpoint to which Crashlytics data should be sent, in the OpenTelemetry format. By default, data will be sent to Firebase. |

## CrashlyticsOptions.appVersion

The version of the application. This should be a unique string that identifies the snapshot of code to be deployed, such as "1.0.2". If not specified, other default locations will be checked for an identifier. Setting a value here takes precedence over any other values.

<b>Signature:</b>

```typescript
appVersion?: string;
```

## CrashlyticsOptions.endpointUrl

The URL for the endpoint to which Crashlytics data should be sent, in the OpenTelemetry format. By default, data will be sent to Firebase.

<b>Signature:</b>

```typescript
endpointUrl?: string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export declare namespace Instrumentation
| Type Alias | Description |
| --- | --- |
| [onRequestError](./telemetry_.instrumentation.md#instrumentationonrequesterror) | |
| [onRequestError](./crashlytics_.instrumentation.md#instrumentationonrequesterror) | |
## Instrumentation.onRequestError
Expand Down
Loading
Loading