electron/docs/api
Shelley Vohr 49096c2359
fix: throw on invalid webRequest filters (#19337)
Closes #11371.

Previously, we didn't consider the return value of the webRequest URLPattern mate converter, which meant that when the pattern wasn't correctly parsed owing to invalid filter specification users would not be made aware of that fact and would just think that the filtering itself had failed. This corrects that error by moving the business logic of url pattern parsing out of the converter and into the function itself so that granular and specific errors can be thrown.

There's also no real reason that i'm aware of not to allow wider breadth of filters by letting users use a wildcard for effective TLD, so I also overrode that (default for the 1-arg Parse is not to allow that).

Finally, I added some examples of url filter types for users to reference.
2019-07-25 10:20:02 -07:00
..
modernization feat: convert webContents primitives to properties (#18998) 2019-07-03 08:57:10 -07:00
structures feat: add memory to app.getAppMetrics() (#18831) 2019-07-23 13:41:58 -07:00
accelerator.md feat: add support for scroll lock accelerator (#16873) 2019-02-11 09:13:13 -10:00
app.md feat: app.moveToApplicationsFolder conflict handling (#18916) 2019-07-15 09:34:20 -07:00
auto-updater.md doc: improve EventEmitter md formatting (#19345) 2019-07-22 08:20:43 -07:00
breaking-changes-ns.md docs: documentation of NetworkService-based protocol module (#18952) 2019-06-28 16:25:30 +09:00
breaking-changes.md chore: deprecate setHighlightMode (#19202) 2019-07-11 10:11:46 -05:00
browser-view.md test: move BrowserView specs to main process (#19409) 2019-07-24 08:44:24 -07:00
browser-window-proxy.md refactor: use IPC helpers in window-setup (#17948) 2019-07-09 02:43:49 +03:00
browser-window.md test: move BrowserView specs to main process (#19409) 2019-07-24 08:44:24 -07:00
chrome-command-line-switches.md docs: fix spelling and grammar errors (#18910) 2019-06-21 16:19:21 -05:00
client-request.md doc: improve EventEmitter md formatting (#19345) 2019-07-22 08:20:43 -07:00
clipboard.md docs: fix spelling and grammar errors (#18910) 2019-06-21 16:19:21 -05:00
command-line.md build: move to the new docs parser (#18103) 2019-05-06 08:29:01 -07:00
content-tracing.md docs: ensure that optionality matches between documented params and signatures (#18613) 2019-06-04 14:03:24 -07:00
cookies.md docs: fix spelling and grammar errors (#18910) 2019-06-21 16:19:21 -05:00
crash-reporter.md docs: fix spelling and grammar errors (#18910) 2019-06-21 16:19:21 -05:00
debugger.md build: move to the new docs parser (#18103) 2019-05-06 08:29:01 -07:00
desktop-capturer.md build: move to the new docs parser (#18103) 2019-05-06 08:29:01 -07:00
dialog.md chore: convert more files to TypeScript (#18820) 2019-07-17 10:23:52 -07:00
dock.md build: move to the new docs parser (#18103) 2019-05-06 08:29:01 -07:00
download-item.md doc: improve EventEmitter md formatting (#19345) 2019-07-22 08:20:43 -07:00
environment-variables.md refactor: remove hardcoded google api key (#15478) 2018-10-31 07:49:44 -07:00
file-object.md docs: es6ify 'Breaking Changes' and 'File' API pages (#15507) 2018-12-05 23:14:52 +11:00
frameless-window.md fix: incorrect view ordering for customButtonsOnHover (#15564) 2018-12-10 11:05:30 -08:00
global-shortcut.md chore: move ts-smoke tests to core (#16930) 2019-02-13 15:24:28 -08:00
in-app-purchase.md docs: ensure that optionality matches between documented params and signatures (#18613) 2019-06-04 14:03:24 -07:00
incoming-message.md doc: improve EventEmitter md formatting (#19345) 2019-07-22 08:20:43 -07:00
ipc-main.md docs: fix broken link in ipcMain docs (#19401) 2019-07-24 11:39:39 -07:00
ipc-renderer.md doc: improve EventEmitter md formatting (#19345) 2019-07-22 08:20:43 -07:00
locales.md Use actual Chromium l10n_util list in locales.md 2017-05-01 17:15:37 -04:00
menu-item.md add toolTip property for MenuItem (#19099) 2019-07-11 17:56:22 +09:00
menu.md docs: fix undefined isMac in menu example (#19071) 2019-07-02 10:09:10 -05:00
native-image.md docs: ensure that optionality matches between documented params and signatures (#18613) 2019-06-04 14:03:24 -07:00
net-log.md refactor: netLog directly uses network service (#18289) 2019-05-23 15:31:38 -07:00
net.md fix: match net module headers & http.IncomingMessage headers (#17517) 2019-04-02 07:41:19 -07:00
notification.md test: move Notification spec to main process (#19414) 2019-07-24 17:18:11 -07:00
power-monitor.md chore: remove deprecated APIs (#18159) 2019-05-09 14:48:10 -04:00
power-save-blocker.md chore: update to standard 12 2018-09-14 14:57:01 +10:00
process.md feat: add process.getBlinkMemoryInfo() (#17762) 2019-05-30 11:50:35 +02:00
protocol-ns.md docs: documentation of NetworkService-based protocol module (#18952) 2019-06-28 16:25:30 +09:00
protocol.md docs: UploadData does not have contentType (#19026) 2019-06-28 11:19:01 -07:00
remote.md build: move to the new docs parser (#18103) 2019-05-06 08:29:01 -07:00
sandbox-option.md refactor: bundle the browser and renderer process electron code (#18553) 2019-06-02 13:03:03 -07:00
screen.md doc: improve EventEmitter md formatting (#19345) 2019-07-22 08:20:43 -07:00
session.md Revert "feat: only allow bundled preload scripts (#17308)" (#18091) 2019-06-20 08:39:12 +09:00
shell.md docs: fix platform location for params (#18987) 2019-06-27 14:51:18 -07:00
synopsis.md chore: update to standard 12 2018-09-14 14:57:01 +10:00
system-preferences.md test: add tests for systemPreferences apis (#19419) 2019-07-24 10:40:12 -07:00
touch-bar-button.md 📝 Fix dead urls 2018-04-09 17:58:10 -03:00
touch-bar-color-picker.md 📝 Fix dead urls 2018-04-09 17:58:10 -03:00
touch-bar-group.md 📝 Fix dead urls 2018-04-09 17:58:10 -03:00
touch-bar-label.md 📝 Fix dead urls 2018-04-09 17:58:10 -03:00
touch-bar-popover.md 📝 Fix dead urls 2018-04-09 17:58:10 -03:00
touch-bar-scrubber.md 📝 Fix dead urls 2018-04-09 17:58:10 -03:00
touch-bar-segmented-control.md 📝 Fix dead urls 2018-04-09 17:58:10 -03:00
touch-bar-slider.md 📝 Fix dead urls 2018-04-09 17:58:10 -03:00
touch-bar-spacer.md 📝 Fix dead urls 2018-04-09 17:58:10 -03:00
touch-bar.md build: move to the new docs parser (#18103) 2019-05-06 08:29:01 -07:00
tray.md feat: support mouse-move event of Tray API on Windows (#19265) 2019-07-18 10:52:15 -07:00
web-contents.md doc: improve EventEmitter md formatting (#19345) 2019-07-22 08:20:43 -07:00
web-frame.md feat: add removeInsertedCSS (#16579) 2019-06-17 11:39:35 -04:00
web-request.md fix: throw on invalid webRequest filters (#19337) 2019-07-25 10:20:02 -07:00
webview-tag.md fix: do not wait on promise returned by remote APIs (#18990) 2019-07-10 08:20:28 -05:00
window-open.md docs: specify BrowserWindow features passable to window.open 2018-09-10 17:49:54 +02:00