Skip to content

Commit 68d0d20

Browse files
committed
documentation
1 parent 0371a54 commit 68d0d20

File tree

4 files changed

+38
-96
lines changed

4 files changed

+38
-96
lines changed

docs-devsite/_toc.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -675,7 +675,5 @@ toc:
675675
- title: telemetry
676676
path: /docs/reference/js/telemetry.md
677677
section:
678-
- title: RequestErrorContext
679-
path: /docs/reference/js/telemetry.requesterrorcontext.md
680678
- title: Telemetry
681679
path: /docs/reference/js/telemetry.telemetry.md
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# Instrumentation namespace
13+
<b>Signature:</b>
14+
15+
```typescript
16+
export declare namespace Instrumentation
17+
```
18+
19+
## Type Aliases
20+
21+
| Type Alias | Description |
22+
| --- | --- |
23+
| [onRequestError](./telemetry.instrumentation.md#instrumentationonrequesterror) | |
24+
25+
## Instrumentation.onRequestError
26+
27+
<b>Signature:</b>
28+
29+
```typescript
30+
type onRequestError = InstrumentationOnRequestError;
31+
```

docs-devsite/telemetry.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,19 @@ https://github.com/firebase/firebase-js-sdk
2525

2626
| Interface | Description |
2727
| --- | --- |
28-
| [RequestErrorContext](./telemetry.requesterrorcontext.md#requesterrorcontext_interface) | Copyright 2025 Google LLC<!-- -->Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at<!-- -->http://www.apache.org/licenses/LICENSE-2.0<!-- -->Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
2928
| [Telemetry](./telemetry.telemetry.md#telemetry_interface) | An instance of the Firebase Telemetry SDK.<!-- -->Do not create this instance directly. Instead, use [getTelemetry()](./telemetry.md#gettelemetry_cf608e1)<!-- -->. |
3029

31-
## Variables
30+
## Namespaces
3231

33-
| Variable | Description |
32+
| Namespace | Description |
3433
| --- | --- |
35-
| [nextOnRequestError](./telemetry.md#nextonrequesterror) | Automatically report uncaught errors from server routes to Firebase Telemetry. |
34+
| [Instrumentation](./telemetry.instrumentation.md#instrumentation_namespace) | |
3635

37-
## Type Aliases
36+
## Variables
3837

39-
| Type Alias | Description |
38+
| Variable | Description |
4039
| --- | --- |
41-
| [InstrumentationOnRequestError](./telemetry.md#instrumentationonrequesterror) | |
40+
| [nextOnRequestError](./telemetry.md#nextonrequesterror) | Automatically report uncaught errors from server routes to Firebase Telemetry. |
4241

4342
## function(app, ...)
4443

@@ -125,7 +124,7 @@ Automatically report uncaught errors from server routes to Firebase Telemetry.
125124
<b>Signature:</b>
126125

127126
```typescript
128-
nextOnRequestError: InstrumentationOnRequestError
127+
nextOnRequestError: Instrumentation.onRequestError
129128
```
130129

131130
### Example
@@ -137,14 +136,3 @@ export { nextOnRequestError as onRequestError } from 'firebase/telemetry'
137136

138137
```
139138

140-
## InstrumentationOnRequestError
141-
142-
<b>Signature:</b>
143-
144-
```typescript
145-
export type InstrumentationOnRequestError = (error: unknown, errorRequest: Readonly<{
146-
path: string;
147-
method: string;
148-
headers: NodeJS.Dict<string | string[]>;
149-
}>, errorContext: Readonly<RequestErrorContext>) => void | Promise<void>;
150-
```

docs-devsite/telemetry.requesterrorcontext.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

0 commit comments

Comments
 (0)