Repository navigation
Fix README option examples and document request tracking - #555
Merged
Merged
Conversation
- The Tracking examples assigned Pace.options, which has no effect after pace loads; they now use paceOptions, and the README says options are read once, when pace.js loads. - Document trackMethods (how to track POST), the restartOnRequestAfter value, what ignoreURLs matches, trackWebSockets, that Pace.ignore and Pace.track only cover requests opened inside the callback, and what Pace can't track. - Advise against calling Pace.restart() for every request. - Recommend pace-js@1 instead of pace-js@latest, and fix Pace.start(). - The release badge uses shields.io's current route (the old one redirects, which shows as a broken image on npm); the stars badge links to the repository (the stargazers page needs a login).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes README examples that didn't work and documents how request tracking
behaves. Documentation only.
Changes
Pace.options, which has no effect afterpace loads. They now use
paceOptions, and the README says options areread once, when pace.js loads.
trackMethods(how to track POST), therestartOnRequestAftervalue, what
ignoreURLsmatches,trackWebSockets, the scope ofPace.ignore/Pace.track, and what Pace can't track.Pace.restart()for every request.pace-js@1instead ofpace-js@latest, and fixesPace.start().redirects, which npm shows as a broken image); the stars badge links to
the repository.