File tree Expand file tree Collapse file tree 7 files changed +80
-3
lines changed Expand file tree Collapse file tree 7 files changed +80
-3
lines changed Original file line number Diff line number Diff line change 1+ ## API Report File for "@firebase/telemetry "
2+
3+ > Do not edit this file. It is a report generated by [ API Extractor] ( https://api-extractor.com/ ) .
4+
5+ ``` ts
6+
7+ // @public (undocumented)
8+ export function registerTelemetry(): void ;
9+
10+ // @public (undocumented)
11+ export function testFxn(): number ;
12+
13+
14+ // (No @packageDocumentation comment for this package)
15+
16+ ```
Original file line number Diff line number Diff line change 648648 path : /docs/reference/js/storage.uploadtask.md
649649 - title : UploadTaskSnapshot
650650 path : /docs/reference/js/storage.uploadtasksnapshot.md
651+ - title : telemetry
652+ path : /docs/reference/js/telemetry.md
653+ section : []
Original file line number Diff line number Diff line change @@ -28,4 +28,5 @@ https://github.com/firebase/firebase-js-sdk
2828| [ @firebase/performance ] ( ./performance.md#performance_package ) | The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment. |
2929| [ @firebase/remote-config ] ( ./remote-config.md#remote-config_package ) | The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environment. |
3030| [ @firebase/storage ] ( ./storage.md#storage_package ) | Cloud Storage for Firebase |
31+ | [ @firebase/telemetry ] ( ./telemetry.md#telemetry_package ) | |
3132
Original file line number Diff line number Diff line change 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 package
13+
14+ ## Functions
15+
16+ | Function | Description |
17+ | --- | --- |
18+ | [ registerTelemetry()] ( ./telemetry.md#registertelemetry ) | |
19+ | [ testFxn()] ( ./telemetry.md#testfxn ) | |
20+
21+ ## function()
22+
23+ ### registerTelemetry() {:#registertelemetry}
24+
25+ <b >Signature:</b >
26+
27+ ``` typescript
28+ export declare function registerTelemetry(): void ;
29+ ```
30+ <b >Returns:</b >
31+
32+ void
33+
34+ ### testFxn() {:#testfxn}
35+
36+ <b >Signature:</b >
37+
38+ ``` typescript
39+ export declare function testFxn(): number ;
40+ ```
41+ <b >Returns:</b >
42+
43+ number
44+
Original file line number Diff line number Diff line change 1+ {
2+ "extends" : " ../../config/api-extractor.json" ,
3+ // Point it to your entry point d.ts file.
4+ "mainEntryPointFilePath" : " <projectFolder>/dist/src/index.d.ts" ,
5+ "dtsRollup" : {
6+ "enabled" : true ,
7+ "untrimmedFilePath" : " <projectFolder>/dist/<unscopedPackageName>.d.ts" ,
8+ "betaTrimmedFilePath" : " <projectFolder>/dist/<unscopedPackageName>-public.d.ts"
9+ }
10+ }
Original file line number Diff line number Diff line change 3535 "test:all" : " run-p --npm-path npm test:browser test:node" ,
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" ,
38- "trusted-type-check" : " tsec -p tsconfig.json --noEmit"
38+ "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" ,
40+ "typings:public" : " node ../../scripts/build/use_typings.js ./dist/telemetry-public.d.ts"
3941 },
4042 "peerDependencies" : {
4143 "@firebase/app" : " 0.x" ,
6769 "bugs" : {
6870 "url" : " https://github.com/firebase/firebase-js-sdk/issues"
6971 },
70- "typings" : " dist/index.d.ts" ,
72+ "typings" : " dist/src/ index.d.ts" ,
7173 "nyc" : {
7274 "extension" : [
7375 " .ts"
Original file line number Diff line number Diff line change @@ -60,7 +60,8 @@ const PREFERRED_PARAMS = [
6060 'performance' ,
6161 'remoteConfig' ,
6262 'storage' ,
63- 'ai'
63+ 'ai' ,
64+ 'telemetry'
6465] ;
6566
6667let authApiReportOriginal : string ;
You can’t perform that action at this time.
0 commit comments