Skip to content

Commit 191b864

Browse files
hsubox76tonybaroneee
hsubox76
authored and
tonybaroneee
committed
fix docs
1 parent c13c5ad commit 191b864

File tree

5 files changed

+137
-15
lines changed

5 files changed

+137
-15
lines changed

‎common/api-review/telemetry.api.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,23 @@
44
55
```ts
66

7-
// @public (undocumented)
8-
export function registerTelemetry(): void;
7+
import { FirebaseApp } from '@firebase/app';
8+
import { LoggerProvider } from '@opentelemetry/sdk-logs';
99

10-
// @public (undocumented)
11-
export function testFxn(): number;
10+
// @public
11+
export function captureError(telemetry: Telemetry, error: unknown): void;
12+
13+
// @public
14+
export function flush(telemetry: Telemetry): Promise<void>;
15+
16+
// @public
17+
export function getTelemetry(app?: FirebaseApp): Telemetry;
18+
19+
// @public
20+
export interface Telemetry {
21+
app: FirebaseApp;
22+
loggerProvider: LoggerProvider;
23+
}
1224

1325

1426
// (No @packageDocumentation comment for this package)

‎docs-devsite/telemetry.md

Lines changed: 70 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,92 @@ https://github.com/firebase/firebase-js-sdk
1515

1616
| Function | Description |
1717
| --- | --- |
18-
| [registerTelemetry()](./telemetry.md#registertelemetry) | |
19-
| [testFxn()](./telemetry.md#testfxn) | |
18+
| <b>function(app, ...)</b> |
19+
| [getTelemetry(app)](./telemetry.md#gettelemetry_cf608e1) | Returns the default [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. If no instance exists, initializes a new instance with the default settings. |
20+
| <b>function(telemetry, ...)</b> |
21+
| [captureError(telemetry, error)](./telemetry.md#captureerror_7c2d94e) | Enqueues an error to be uploaded to the Firebase Telemetry API. |
22+
| [flush(telemetry)](./telemetry.md#flush_8975134) | Flushes all enqueued telemetry data immediately, instead of waiting for default batching. |
2023

21-
## function()
24+
## Interfaces
2225

23-
### registerTelemetry() {:#registertelemetry}
26+
| Interface | Description |
27+
| --- | --- |
28+
| [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)<!-- -->. |
29+
30+
## function(app, ...)
31+
32+
### getTelemetry(app) {:#gettelemetry_cf608e1}
33+
34+
Returns the default [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. If no instance exists, initializes a new instance with the default settings.
2435

2536
<b>Signature:</b>
2637

2738
```typescript
28-
export declare function registerTelemetry(): void;
39+
export declare function getTelemetry(app?: FirebaseApp): Telemetry;
2940
```
41+
42+
#### Parameters
43+
44+
| Parameter | Type | Description |
45+
| --- | --- | --- |
46+
| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) to use. |
47+
48+
<b>Returns:</b>
49+
50+
[Telemetry](./telemetry.telemetry.md#telemetry_interface)
51+
52+
The default [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance for the given [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->.
53+
54+
### Example
55+
56+
57+
```javascript
58+
const telemetry = getTelemetry(app);
59+
60+
```
61+
62+
## function(telemetry, ...)
63+
64+
### captureError(telemetry, error) {:#captureerror_7c2d94e}
65+
66+
Enqueues an error to be uploaded to the Firebase Telemetry API.
67+
68+
<b>Signature:</b>
69+
70+
```typescript
71+
export declare function captureError(telemetry: Telemetry, error: unknown): void;
72+
```
73+
74+
#### Parameters
75+
76+
| Parameter | Type | Description |
77+
| --- | --- | --- |
78+
| telemetry | [Telemetry](./telemetry.telemetry.md#telemetry_interface) | The [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance. |
79+
| error | unknown | the caught exception, typically an |
80+
3081
<b>Returns:</b>
3182

3283
void
3384

34-
### testFxn() {:#testfxn}
85+
### flush(telemetry) {:#flush_8975134}
86+
87+
Flushes all enqueued telemetry data immediately, instead of waiting for default batching.
3588

3689
<b>Signature:</b>
3790

3891
```typescript
39-
export declare function testFxn(): number;
92+
export declare function flush(telemetry: Telemetry): Promise<void>;
4093
```
94+
95+
#### Parameters
96+
97+
| Parameter | Type | Description |
98+
| --- | --- | --- |
99+
| telemetry | [Telemetry](./telemetry.telemetry.md#telemetry_interface) | The [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance. |
100+
41101
<b>Returns:</b>
42102

43-
number
103+
Promise&lt;void&gt;
104+
105+
a promise which is resolved when all flushes are complete
44106

‎docs-devsite/telemetry.telemetry.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
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+
# Telemetry interface
13+
An instance of the Firebase Telemetry SDK.
14+
15+
Do not create this instance directly. Instead, use [getTelemetry()](./telemetry.md#gettelemetry_cf608e1)<!-- -->.
16+
17+
<b>Signature:</b>
18+
19+
```typescript
20+
export interface Telemetry
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| --- | --- | --- |
27+
| [app](./telemetry.telemetry.md#telemetryapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance is associated with. |
28+
| [loggerProvider](./telemetry.telemetry.md#telemetryloggerprovider) | LoggerProvider | The this [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance uses. |
29+
30+
## Telemetry.app
31+
32+
The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance is associated with.
33+
34+
<b>Signature:</b>
35+
36+
```typescript
37+
app: FirebaseApp;
38+
```
39+
40+
## Telemetry.loggerProvider
41+
42+
The this [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance uses.
43+
44+
<b>Signature:</b>
45+
46+
```typescript
47+
loggerProvider: LoggerProvider;
48+
```

‎packages/telemetry/api-extractor.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"extends": "../../config/api-extractor.json",
33
// Point it to your entry point d.ts file.
4-
"mainEntryPointFilePath": "<projectFolder>/dist/src/index.d.ts",
4+
"mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",
55
"dtsRollup": {
66
"enabled": true,
77
"untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",

‎packages/telemetry/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
"test:browser": "karma start",
3737
"test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha src/**/*.test.* --config ../../config/mocharc.node.js",
3838
"trusted-type-check": "tsec -p tsconfig.json --noEmit",
39-
"api-report": "api-extractor run --local --verbose && ts-node-script ../../repo-scripts/prune-dts/prune-dts.ts --input dist/telemetry-public.d.ts --output dist/telemetry-public.d.ts",
39+
"api-report": "api-extractor run --local --verbose",
4040
"typings:public": "node ../../scripts/build/use_typings.js ./dist/telemetry-public.d.ts"
4141
},
4242
"peerDependencies": {
@@ -69,7 +69,7 @@
6969
"bugs": {
7070
"url": "https://github.com/firebase/firebase-js-sdk/issues"
7171
},
72-
"typings": "dist/src/index.d.ts",
72+
"typings": "dist/index.d.ts",
7373
"nyc": {
7474
"extension": [
7575
".ts"

0 commit comments

Comments
 (0)