Samuel Attard
a96b6e2c96
build: move to the new docs parser ( #18103 )
...
* build: move to the new docs parser
* chore: remove the bad getTitle param doc
* build: update parser/ts gen deps + fix some docs issues highlighted by GH desktop
* chore: apply suggestions from code review
Co-Authored-By: MarshallOfSound <samuel.r.attard@gmail.com>
* chore: update docs for accidentally removed things
* chore: update docs/api/command-line.md
Co-Authored-By: MarshallOfSound <samuel.r.attard@gmail.com>
2019-05-06 08:29:01 -07:00
Shelley Vohr
d87b3ead76
chore: remove promisification deprecation callbacks ( #17907 )
...
* chore: remove promisification deprecation callbacks
* update docs
* fix smoke test
* fix executejs issue
* cleanup leftovers
* fix webContents.executeJavaScript tests
* cleanup WebContents.prototype.takeHeapSnapshot
* fix "sets arbitrary webContents as devtools" test
* fix executeJavaScriptInFrame related tests
2019-04-30 07:08:32 -07:00
Shelley Vohr
d412582f72
docs: clarify cookie domain normalization ( #17590 )
2019-04-02 13:04:20 -07:00
Samuel Attard
784f9742bc
build: auto-fix whitespace in docs in pre-commit hook ( #17490 )
2019-03-21 12:15:55 -07:00
Milan Burda
de1bacddd9
docs: process.getProcessMemoryInfo() returns a Promise ( #16593 )
...
* docs: process.getProcessMemoryInfo() returns a Promise
* chore: bump electron-typescript-definitions to get Promise<T> fix
2019-03-20 17:26:57 +01:00
Shelley Vohr
1d93bc76cd
feat: expose colorSpace to display object ( #17405 )
...
* feat: expose colorSpace to display object
* update doc
* add a spec
2019-03-19 15:12:03 -07:00
Zachary
9b359c6a75
docs: correction to ipc-main-event.md 'frane' to 'frame' ( #17424 )
2019-03-19 12:07:30 -07:00
Shelley Vohr
3edc497d3d
feat: show user gesture type in click event ( #16954 )
2019-02-20 12:20:24 +00:00
Samuel Attard
3b74837020
refactor: Split 'Event' docs/types into more specific Event types ( #17038 )
...
* Event = Base event type (with preventDefault)
* IpcMainEvent = Event that ipcMain emits (with sender, reply, etc.)
* IpcRendererEvent = Event that ipcRenderer emits (with sender,
senderId, etc.)
* KeyboardEvent = Event that we emit with keyboard flags (ctrlKey,
altKey, etc.)
This will dramatically improve peoples TS experience with IPC events
2019-02-19 09:24:19 +00:00
Shelley Vohr
1e8ac79e6f
docs: document the Event interface ( #16966 )
...
* docs: document the Event interface
* update docs deps
* pull new VoidFunction update
2019-02-15 12:08:45 -08:00
Shelley Vohr
bf276ecc69
feat: add new components to Display structure ( #16870 )
...
* feat: add new components to Display structure
* add internal property
* expose colorDepth
* add specs
2019-02-12 05:34:42 -10:00
Nitish Sakhawalkar
bd4e14dcee
fix: update docs for protocol API ( #16601 )
...
* fix: update docs for protocol API
* upddate source for new attribute name
* update electron-typescript-definitions package
2019-01-30 12:54:18 -08:00
Nitish Sakhawalkar
940c4c0787
feat: move webFrame scheme privilege methods to main process ( #16416 )
...
* chore: deprecate webFrame.registerURLSchemeAsPrivileged
* Add register schemes protocol api
* update branch to enable browser process API
* Revert deprecation changes
* Fetch API support
* Updated api to take an array, still working on tests
* Update tests
* Remove web frame API
* Minor changes
* update scheme registrations on browser and renderer process
* fix: enable ses.getBlobData spec
* Update breaking changes doc
2019-01-29 16:11:01 +09:00
Zac Walker
51cfb5cff1
fix: extend tracing startRecording API to take a full tracing config ( #13914 )
...
This allows memory-infra to be traced correctly.
Fixes #12506 .
2018-12-20 15:11:17 +03:00
Julien Isorce
1f55f1635f
feat: add support for DesktopCapturerSource.appIcon
...
Useful to get the icon of the application owning the source.
Only available for sources of type window, i.e. not for screen.
https://github.com/electron/electron/issues/14845
2018-12-04 15:42:49 +09:00
Samuel Attard
73a1a8b3f0
feat: automatically round numbers that are converted to points ( #14604 )
...
Fixes #14490
2018-09-13 08:28:56 -05:00
Samuel Attard
dde194d853
Remove the memory property from getAppMetrics
...
See 03d0bfd593
for more information
2018-09-11 20:24:03 +02:00
Tiago Danin
1fd6d38a0a
docs: Improved documentation ( #13403 )
2018-07-20 10:58:19 -07:00
deepak1556
c4b8e106c0
Create network_converter for services/network/* types
2018-06-19 11:49:42 +10:00
Shelley Vohr
265aa3da29
docs: deprecate UploadFileSystem ( #13064 )
...
Deprecate UploadFileSystem in preparation for its being phased out completely in Chromium 66 and correspondingly Electron 4.0.0.
2018-05-25 10:50:27 -07:00
Samuel Attard
0bb29e092d
fix: update docs for the ts parser ( #12902 )
2018-05-12 18:12:28 +10:00
Charles Kerr
8acbfca06b
Make Referrer.policy types parseable by e-t-d
2018-05-11 12:40:46 -05:00
Charles Kerr
4d078fdb03
Remove more words ( #12852 )
...
* remove 'basically' from docs
* remove 'simply' from docs
* remove most uses of 'just' from docs
2018-05-08 00:16:09 -05:00
Rahat Ahmed
5ba9f6a966
docs: Fix typo in transaction.md ( #12804 )
2018-05-03 00:01:49 -05:00
Andrew MacDonald
6bfb122cd1
Add a display_id parameter to the desktopCapturer API. ( #12417 )
...
* Add a screen_api_id parameter to the desktopCapturer API.
When using the DirectX capturer on Windows, there was previously no way
to associate desktopCapturer/getUserMedia and electron.screen API
screens. This new parameter provides the association.
* Fix non-Windows build.
* Fix Mac.
* Fix Mac harder.
* JS lint
* clang-format C++ code.
* IWYU
* display_id, Linux comment, better test
* lint
* Fix tests on Linux.
* Add display_id documentation.
2018-04-09 14:43:35 +09:00
Jeremy Apthorp
f0d08f4da1
Propagate referrer to new windows ( #12397 )
...
* Propagate referrer to new windows
Fixes #9205
* Rearrange -new-window event arguments for backwards-compatibility
* Plumb referrer policy through guest-window-manager
* Document the Referrer structure and its uses
* Add tests for referrer in new windows
* Docs nits
2018-04-05 18:13:24 -05:00
Adrien Fery
5486a65702
Improve in-app purchase for MacOS ( #12464 )
...
* Add methods to finish transactions
* Add a method to get the product descriptions from the App Store
* Improve the documentation of a transaction structure
* Add a tutorial for In App Purchase
* Fix typo in In-App Purchase tutorial
* Fix style of In-App Purchase files
* Fix In-App-Purchase product structure conversion in amr64
* Fix code style in In-App Purchase tutorial documentation
* Fix typos in In-App Purchase documentation
* Fix typo in In-App Purchase spec
* Slight style fixes
2018-04-05 15:33:13 +09:00
Zhuo Lu
e3b70dd029
Fix grammar
2018-02-10 03:20:20 -08:00
Zhuo Lu
d05791c1ac
Tweak wording
2018-02-10 03:20:20 -08:00
Zhuo Lu
bf11b09d35
Mention change of default value scenario in doc
2018-02-10 03:20:20 -08:00
Zhuo Lu
69e65e0d5e
Update NotificationAction doc
2018-02-10 03:20:20 -08:00
Zhuo Lu
3ee3e9a3e8
Fix typo
2018-02-10 03:20:20 -08:00
Tim Fish
e3383c82d1
CrashReport structure does not match API output
...
Electron 1.7
Docs:
```typescript
interface CrashReport {
date: string;
ID: number;
}
```
Actual output of `getLastCrashReport`:
```javascript
{
date: 2018-01-26T21:50:05.000Z,
id: '989d0469-9eb7-4f70-ba58-3425bc6ffa3b'
}
```
2018-01-27 12:21:09 +01:00
Cheng Zhao
e77ddd3221
Pass multiple transactions at the same time
...
This follows the design of SKPayment API.
2018-01-10 17:19:44 +09:00
Hugo Mano
ae7b96991c
Add webFrame.setIsolatedWorldSecurityOrigin
...
Move vector to cc file
Map executed javascript in isolated world to url
Some 💅
Documentation
Use WebSource[] as argument in executeJavaScriptInIsolatedWorld
Refactor and lint with @poiru’s comments
Remove duplicate call
Typo
Lint
2017-12-19 10:36:03 +09:00
Charles Kerr
6beaafc7e5
Merge pull request #11282 from Toinane/fix-documentation
...
typographical revision in Documentation
2017-12-03 09:01:24 -06:00
Zeke Sikelianos
7dd921811f
fix typos in structures
2017-12-01 11:43:04 -08:00
Toinane
59607c9a17
feat(docs): fix 'optional' wording
2017-11-28 18:15:15 +01:00
Thiago de Arruda
5e8618ec3b
Add documentation for {intercept,register}StreamProtocol.
2017-11-13 16:16:14 -03:00
Felix Rieseberg
c4de658964
📝 Make a note in the docs
2017-10-03 10:25:42 -07:00
Zeke Sikelianos
d27f7c25b3
Revert "PrinterInfo options object causes TypeScript error"
2017-09-24 11:11:04 +09:00
Kevin Sawicki
53b0698ee2
Add options object
2017-09-14 14:57:59 +09:00
Toinane
1cb13be65f
style: fix the word incompatible in docs
2017-09-12 15:51:53 +02:00
Samuel Attard
b8be81f101
Fix structure docs
2017-06-24 00:30:13 +10:00
Samuel Attard
17e737eba2
s/label/text
2017-06-23 21:04:39 +10:00
Samuel Attard
96f9dba595
Document the reply / button compatibility state
2017-06-23 20:56:55 +10:00
Samuel Attard
4f0d48f164
Add support for notification actions on macOS
2017-06-23 20:50:20 +10:00
Zeke Sikelianos
56ee50f3a3
use lowercase for optional annotation
2017-06-13 13:50:10 -07:00
Vanessa Yuen
cd28bdd815
add integer note to each parameter
2017-06-13 11:51:55 -07:00
Brian Fajardo
1f73942922
Update rectangle.md (issue #9552 )
...
Clear confusion regarding rectangle object parameter values
2017-06-09 17:13:57 -04:00
Kagami
a702f8a5f5
add peak working set size comment
2017-06-09 01:05:53 +08:00
Milan Burda
0ecfb4e2f8
Add app.getGPUFeatureStatus
2017-05-30 20:35:14 +02:00
Kevin Sawicki
385d6faf1a
Remove options to appease typescript definitions
2017-05-26 13:33:09 -07:00
Kevin Sawicki
cabcd0ef8f
Fix typos in ProcessMetric doc
2017-05-26 08:36:51 -07:00
Hari Juturu
939747945e
Adding CPU & Memory metrics for App
2017-05-24 21:07:35 -07:00
Kevin Sawicki
73b49f0dfe
Fix JSON issue in example block
2017-05-18 11:28:10 -07:00
Kevin Sawicki
a8d25d6855
Add printer info structure file
2017-05-18 10:50:08 -07:00
Kevin Sawicki
edac443673
Correct property name to pid
2017-05-10 14:26:13 -07:00
Hari Krishna Reddy Juturu
472dad1ffc
convert var to const
2017-05-04 14:33:59 -07:00
Hari Krishna Reddy Juturu
8a5aa04756
Adding CPU and I/O metrics to process module
2017-05-04 14:33:59 -07:00
Kevin Sawicki
edd28c9a91
Link to MemoryInfo structure
2017-05-04 13:35:12 -07:00
Hari Krishna Reddy Juturu
27aad902b8
Adding docs, specs and fixing object returned
2017-04-27 14:06:53 -07:00
Tasuku Uno
59fe7d3dbb
📝 Fix document of MimeTypedBuffer Object
...
[ci skip]
2017-04-06 11:38:59 +09:00
Milan Burda
568454525d
Use point / size / rectangle structures consistently in API docs
2017-04-04 08:31:09 +02:00
Kevin Sawicki
466c39ed19
Use icon for consistency with other touch bar APIs
2017-03-15 09:33:11 -07:00
Samuel Attard
cfb3798703
Add docs for TouchBarScrubbber
2017-03-13 11:00:25 +11:00
Samuel Attard
e6a66b6006
Add docs for segmented control touch bar item
2017-03-10 17:50:23 +11:00
Cheng Zhao
5e43ea227e
purgedSize and purgeableSize are removed by Chrome
2017-02-06 10:34:29 -08:00
Kevin Sawicki
afa3bd2143
Put optional label before dash
2016-12-29 14:11:26 -08:00
Kevin Sawicki
f99dabbac6
Merge pull request #8078 from electron/dts-docs-update-again
...
Update Docs
2016-12-21 13:39:53 -08:00
Zeke Sikelianos
9e626c5fee
fix relative link to CertificatePrincipal doc
2016-12-19 13:49:02 -08:00
deepak1556
975d677f55
add docs
2016-12-09 09:56:16 -08:00
Samuel Attard
06960704c4
Update docs for dts again
2016-11-25 23:17:31 +11:00
George Hafiz
aac31159b8
Update formatting to prevent '[] ()' sequences (e.g. String[] (optional)), which breaks MD rendering on GitHub and hides the array indication
2016-11-18 00:34:48 +00:00
Zeke Sikelianos
d6684c4dcd
fix UploadBlob heading
2016-11-16 09:02:49 -08:00
Zeke Sikelianos
2b689a21e7
fix structure headings
2016-11-16 09:02:49 -08:00
Greg Nolle
5d028f9163
Expose extra certificate information: full breakdown of issuer and subject principals, as well as full structure of intermediate issuer certificates.
2016-11-15 15:53:42 -08:00
Greg Nolle
446399c3c1
Expose whole certificate chain to verify proc and certificate-error event.
2016-11-15 15:53:42 -08:00
deepak1556
61576c39be
uploadData => uploadRawData
2016-11-11 10:54:01 -08:00
deepak1556
723a3eda8b
update docs
2016-11-11 10:54:01 -08:00
deepak1556
dbe57c4ad4
update docs
2016-11-11 10:54:01 -08:00
Samuel Attard
c1af62a3b3
Move crash-report object to it's own struct
2016-11-11 09:22:55 -08:00
Samuel Attard
63ebc41778
More docs updates
2016-11-11 09:22:55 -08:00
Kevin Sawicki
a2a44621fd
Merge pull request #7708 from tinydew4/fix-typo
...
Fix typo, and trimming.
2016-10-24 16:12:29 +09:00
tinydew4
67a09d9fe0
Fix typo, and trimming.
2016-10-24 06:34:09 +00:00
Kevin Sawicki
632739ec6e
Merge pull request #7590 from electron/docs-cleanup
...
Cleanup docs and standardize structs
2016-10-24 15:13:39 +09:00
Samuel Attard
9d0d1c8341
Fix bd object name
2016-10-18 15:47:18 +11:00
Samuel Attard
ba91bbd397
Fix spaces
2016-10-14 22:54:04 +11:00
Samuel Attard
32c3f17f5a
Rename dcs object
2016-10-14 13:00:03 +11:00
Samuel Attard
ad45c084cc
Fix uploaddata naming
2016-10-14 11:37:36 +11:00
Samuel Attard
20323e7032
Specifiy function param types in docs
2016-10-13 17:30:57 +11:00
Samuel Attard
78343a62b8
Cleanup docs and standardize structs
2016-10-13 14:38:06 +11:00
Zeke Sikelianos
2acd7f4d12
fix NativeImage link path
2016-10-07 21:25:39 -07:00
Samuel Attard
4d49156dac
Rename bounds -> rectangle
2016-10-08 13:09:31 +11:00
Samuel Attard
2b05c61ae3
Update docs for parsing
2016-10-06 12:19:38 -07:00
Samuel Attard
03979936f3
Move reused object structures to a standard structures folder
2016-10-06 11:59:42 -07:00