Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating the docs #86

Merged
merged 1 commit into from
Apr 16, 2024
Merged

Updating the docs #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
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
Loading