Skip to content
This repository was archived by the owner on Apr 4, 2023. It is now read-only.

Commit 1d741b6

Browse files
author
Juras Norkus
committed
docs(performance): API documentation for http metrics
1 parent 78d6d5a commit 1d741b6

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

docs/PERFORMANCE_MONITORING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,41 @@ if (firebaseTrace) {
8484
firebaseTrace = undefined;
8585
}
8686
```
87+
88+
### `startHttpMetric`
89+
To be able to interact with a started HTTP metric, you can remember it in a property (in this case `firebaseHttpMetric`):
90+
91+
```typescript
92+
import { performance as firebasePerformance } from "nativescript-plugin-firebase";
93+
import { FirebaseHttpMetric } from "nativescript-plugin-firebase/performance/performance";
94+
95+
const firebaseHttpMetric: FirebaseHttpMetric = firebasePerformance.startHttpMetric("https://postman-echo.com/get", "GET");
96+
```
97+
98+
Now you can call several functions on the remembered metric object, read on below. And don't forget to use `metric.stop` afterwards.
99+
100+
### `metric.setRequestPayloadSize`
101+
102+
```typescript
103+
if (firebaseHttpMetric) {
104+
firebaseHttpMetric.setRequestPayloadSize(42);
105+
}
106+
```
107+
108+
### `metric.setHttpResponseCode`
109+
110+
```typescript
111+
if (firebaseHttpMetric) {
112+
firebaseHttpMetric.setHttpResponseCode(200);
113+
}
114+
```
115+
116+
### `metric.stop`
117+
To stop the metric, call `stop` on the remembered metric object:
118+
119+
```typescript
120+
if (firebaseHttpMetric) {
121+
firebaseHttpMetric.stop();
122+
firebaseHttpMetric = undefined;
123+
}
124+
```

0 commit comments

Comments
 (0)