Skip to content

Commit

Permalink
Updating the docs (#86)
Browse files Browse the repository at this point in the history
  • Loading branch information
kierrrrra authored Apr 16, 2024
1 parent 44255a0 commit 9c34016
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,9 @@ export type CancellationError = {
// time since timeOrigin that cancellation occurred
end: number;

// the difference between start and end
duration: number;

// reason for cancellation
cancellationReason: CancellationReason;

Expand All @@ -274,6 +277,9 @@ export enum CancellationReason {
// user interaction occurred
USER_INTERACTION = 'USER_INTERACTION',

// measurement was cancelled because a new one was started
NEW_MEASUREMENT = 'NEW_MEASUREMENT',

// manual cancellation via API happened
MANUAL_CANCELLATION = 'MANUAL_CANCELLATION',
}
Expand Down Expand Up @@ -339,7 +345,7 @@ Abort the current TTVC measurement.

This method is provided as an escape hatch. Consider using `cancel` to notify @dropbox/ttvc that a user interaction has occurred and continuing the measurement may produce an invalid result.

An optional argument can be passed specifying the type of event that triggered the cancellation. This will be logged to the error callback, and so is used only for diagnostics.
An optional argument can be passed specifying the event that triggered the cancellation. Type of that event will be logged along with the cancellation to the error callback.

#### `incrementAjaxCount() & decrementAjaxCount()`

Expand Down

0 comments on commit 9c34016

Please sign in to comment.