electron/docs/api/structures
Samuel Attard 12bbbef688
docs: fix type information for contents.sendInputEvent (#19479)
The `event` type and keyword is reserved by the typescript generator, in the future we should throw an error from the generator if someone uses a reserved interface like that.

This also splits and documents the InputEvent type way better so that TS
users get strong type safety.

Fixes electron/typescript-definitions#36
2019-07-26 16:11:50 -07:00
..
bluetooth-device.md
certificate-principal.md docs: Improved documentation (#13403) 2018-07-20 10:58:19 -07:00
certificate.md fix relative link to CertificatePrincipal doc 2016-12-19 13:49:02 -08:00
cookie.md docs: clarify cookie domain normalization (#17590) 2019-04-02 13:04:20 -07:00
cpu-usage.md docs: fix spelling and grammar errors (#18910) 2019-06-21 16:19:21 -05:00
crash-report.md CrashReport structure does not match API output 2018-01-27 12:21:09 +01:00
custom-scheme.md build: auto-fix whitespace in docs in pre-commit hook (#17490) 2019-03-21 12:15:55 -07:00
desktop-capturer-source.md feat: add support for DesktopCapturerSource.appIcon 2018-12-04 15:42:49 +09:00
display.md feat: expose colorSpace to display object (#17405) 2019-03-19 15:12:03 -07:00
event.md refactor: Split 'Event' docs/types into more specific Event types (#17038) 2019-02-19 09:24:19 +00:00
file-filter.md More docs updates 2016-11-11 09:22:55 -08:00
file-path-with-headers.md test: move protocol specs to main process (#18923) 2019-06-27 14:20:29 -07:00
gpu-feature-status.md docs: Improved documentation (#13403) 2018-07-20 10:58:19 -07:00
input-event.md docs: fix type information for contents.sendInputEvent (#19479) 2019-07-26 16:11:50 -07:00
io-counters.md Adding CPU and I/O metrics to process module 2017-05-04 14:33:59 -07:00
ipc-main-event.md docs: fix spelling and grammar errors (#18910) 2019-06-21 16:19:21 -05:00
ipc-main-invoke-event.md feat: add ipcRenderer.invoke() (#18449) 2019-05-31 10:25:19 -07:00
ipc-renderer-event.md refactor: Split 'Event' docs/types into more specific Event types (#17038) 2019-02-19 09:24:19 +00:00
jump-list-category.md Put optional label before dash 2016-12-29 14:11:26 -08:00
jump-list-item.md feat: allow setting working directory in app.setUserTasks() / app.setJumpList() (#18148) 2019-05-13 19:17:12 +03:00
keyboard-event.md feat: show user gesture type in click event (#16954) 2019-02-20 12:20:24 +00:00
keyboard-input-event.md docs: fix type information for contents.sendInputEvent (#19479) 2019-07-26 16:11:50 -07:00
memory-info.md feat: add memory to app.getAppMetrics() (#18831) 2019-07-23 13:41:58 -07:00
memory-usage-details.md purgedSize and purgeableSize are removed by Chrome 2017-02-06 10:34:29 -08:00
mime-typed-buffer.md docs: Improved documentation (#13403) 2018-07-20 10:58:19 -07:00
mouse-input-event.md docs: fix type information for contents.sendInputEvent (#19479) 2019-07-26 16:11:50 -07:00
mouse-wheel-input-event.md docs: fix type information for contents.sendInputEvent (#19479) 2019-07-26 16:11:50 -07:00
notification-action.md Remove more words (#12852) 2018-05-08 00:16:09 -05:00
point.md feat: automatically round numbers that are converted to points (#14604) 2018-09-13 08:28:56 -05:00
printer-info.md Revert "PrinterInfo options object causes TypeScript error" 2017-09-24 11:11:04 +09:00
process-memory-info.md docs: fix platform location for params (#18987) 2019-06-27 14:51:18 -07:00
process-metric.md feat: add memory to app.getAppMetrics() (#18831) 2019-07-23 13:41:58 -07:00
product.md fix: correct isDownloadable docs to match impl (#18720) 2019-06-12 10:54:14 -07:00
protocol-request.md docs: documentation of NetworkService-based protocol module (#18952) 2019-06-28 16:25:30 +09:00
protocol-response-upload-data.md docs: UploadData does not have contentType (#19026) 2019-06-28 11:19:01 -07:00
protocol-response.md docs: UploadData does not have contentType (#19026) 2019-06-28 11:19:01 -07:00
rectangle.md docs: Improved documentation (#13403) 2018-07-20 10:58:19 -07:00
referrer.md fix: update docs for the ts parser (#12902) 2018-05-12 18:12:28 +10:00
remove-client-certificate.md add docs 2016-12-09 09:56:16 -08:00
remove-password.md add docs 2016-12-09 09:56:16 -08:00
scrubber-item.md docs: Improved documentation (#13403) 2018-07-20 10:58:19 -07:00
segmented-control-segment.md docs: Improved documentation (#13403) 2018-07-20 10:58:19 -07:00
shortcut-details.md
size.md Use point / size / rectangle structures consistently in API docs 2017-04-04 08:31:09 +02:00
stream-protocol-response.md test: move protocol specs to main process (#18923) 2019-06-27 14:20:29 -07:00
string-protocol-response.md test: move protocol specs to main process (#18923) 2019-06-27 14:20:29 -07:00
task.md feat: allow setting working directory in app.setUserTasks() / app.setJumpList() (#18148) 2019-05-13 19:17:12 +03:00
thumbar-button.md Put optional label before dash 2016-12-29 14:11:26 -08:00
trace-categories-and-options.md build: move to the new docs parser (#18103) 2019-05-06 08:29:01 -07:00
trace-config.md doc: fix types for traceConfig recording_mode (#19448) 2019-07-25 21:42:28 -07:00
transaction.md fix: update docs for the ts parser (#12902) 2018-05-12 18:12:28 +10:00
upload-blob.md fix UploadBlob heading 2016-11-16 09:02:49 -08:00
upload-data.md docs: UploadData does not have contentType (#19026) 2019-06-28 11:19:01 -07:00
upload-file.md fix typos in structures 2017-12-01 11:43:04 -08:00
upload-raw-data.md fix structure headings 2016-11-16 09:02:49 -08:00
web-source.md build: auto-fix whitespace in docs in pre-commit hook (#17490) 2019-03-21 12:15:55 -07:00