Keeley Hammond
9e421e8f43
docs: add docs API history ( #43362 )
...
feat: add API history
2024-08-19 17:13:55 -04:00
Erick Zhao
09fb892c6e
docs: ensure all links are on a single line ( #42235 )
2024-05-28 11:15:18 -07:00
David Sanders
88f28a302f
docs: improve protocol.handle file examples ( #42111 )
...
* docs: improve protocol.handle file examples
* chore: fix lint
2024-05-13 11:49:18 +02:00
Erick Zhao
b9c4b27781
docs: backslash escape parametrized TypeScript types ( #41575 )
...
* docs: backslash escape parametrized TypeScript types
* missing instances
2024-03-25 11:19:44 +01:00
Cheng Zhao
9aa73abe78
feat: enable code cache for custom protocols ( #40544 )
2023-12-06 11:22:41 +09:00
David Sanders
3d2a754531
chore: extend linting of code blocks in the docs ( #40245 )
...
* chore: extend linting of code blocks in the docs
* chore: combine lint:markdownlint and lint:markdown scripts
2023-11-21 16:50:08 +09:00
Samuel Attard
d504d150ef
feat: add new fuse to treat file: identically to browsers ( #40372 )
2023-11-09 10:23:52 -08:00
Erick Zhao
b8ac798344
docs: use node:
imports for node core modules ( #39681 )
...
docs: use `node:` imports for node builtin modules
2023-08-30 11:55:23 -04:00
David Sanders
905aad9cb6
chore: type check JS in docs ( #38423 )
...
* build(deps): update @electron/lint-roller
* chore: type check JS in docs
* docs: add @ts-check and @ts-expect-error to code blocks
* chore: fix type check errors in docs
* chore: add ts-type to blocks
2023-06-05 16:26:26 +09:00
Jeremy Rose
fda8ea9277
feat: add protocol.handle ( #36674 )
2023-03-27 10:00:55 -07:00
Kishan Bagaria
3a6d6ff008
docs: improve registerFileProtocol example ( #35580 )
...
* improve registerFileProtocol example
* link ProtocolResponse
* kick lint
2022-09-07 14:45:09 -04:00
Milan Burda
e6b1d95a1c
docs: type names changed from wrapper to primitive ( #31752 )
2021-11-15 22:13:18 -06:00
David Sanders
9717dff4fa
docs: link ProtocolRequest doc ( #25761 )
2020-10-05 11:18:18 -04:00
Paul Frazee
c6c022dc46
feat: add {stream} opt to custom protocol registry to configure media player ( #22955 )
2020-06-08 09:49:36 -07:00
Samuel Attard
d3fa5ed1e8
docs: move protocol-ns to protocol.md ( #23883 )
...
* docs: move protocol-ns to protocol.md
* chore: fix up tests and implement missing pieces required for tests
2020-06-02 09:46:18 -07:00
Charles Kerr
c83f836faf
refactor: prefer using app.whenReady() ( #21972 )
...
* docs: add references to app.whenReady() in isReady
* refactor: prefer app.whenReady()
In the docs, specs, and lib, replace instances of `app.once('ready')`
(seen occasionally) and `app.on('ready')` (extremely common) with
`app.whenReady()`.
It's better to encourage users to use whenReady():
1. it handles the edge case of registering for 'ready' after it's fired
2. it avoids the minor wart of leaving an active listener alive for
an event that wll never fire again
2020-02-03 22:43:22 +00:00
Samuel Attard
fcee7212ce
chore: upgrade ts generator for better type safety ( #20975 )
...
* chore: upgrade ts generator for better type safety
* spec: fix tests
2019-11-05 13:34:04 -08:00
Samuel Attard
cfd230d7f1
docs: remove implicit 'any' and 'Object' types from the docs ( #19585 )
...
* docs: remove implicit 'any' and 'Object' types from the docs
* docs: more docs improvements, remove all remaining empty interfaces
* chore: update tests for better types
2019-08-05 10:45:58 -07:00
Cheng Zhao
1d8e16bc6e
docs: UploadData does not have contentType ( #19026 )
2019-06-28 11:19:01 -07:00
Jeremy Apthorp
ec8697bcdc
test: move protocol specs to main process ( #18923 )
2019-06-27 14:20:29 -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
pathim
cc1e8ecef6
docs: Correct doc for registerFileProtocol ( #18022 )
...
In the registerFileProtocol docs the "headers" argument of the callback was described as being a list. In fact is has to be an Object mapping header-entries to values. This can be seen in Line 326 of `/spec/api-protocol-spec.js` [fe618631f1/spec/api-protocol-spec.js (L326)
].
2019-04-29 15:26:55 -07:00
Shelley Vohr
e1acfffaf8
docs: remove outdated refs to protocol.registerStandardSchemes ( #17959 )
2019-04-25 15:56:59 -07:00
Kilian Valkhof
ea6641afe5
docs: explanation on using protocols with partitions ( #17759 )
...
* docs: explanation on using protocols with partitions
* linting fixes
* Update docs/api/protocol.md
Co-Authored-By: Kilian <kilian@kilianvalkhof.com>
* Update docs/api/protocol.md
Co-Authored-By: Kilian <kilian@kilianvalkhof.com>
* Update docs/api/protocol.md
Co-Authored-By: Kilian <kilian@kilianvalkhof.com>
* be more explicit about there being a default session.
2019-04-18 12:40:04 -07:00
Shelley Vohr
879462af4b
docs: document modernization initiative more clearly ( #17376 )
...
* docs: document modernization initiative more clearly
2019-03-19 10:31:45 -07:00
Koen [XII]
aa863f3246
Fix typo in registerSchemesAsPrivileged reference ( #17214 )
2019-03-05 09:20:52 -08:00
Robo
5478cc7e8e
chore: fix lint errors ( #16906 )
2019-02-13 00:19:47 +05:30
Jeremy Apthorp
5a44cc50cf
docs: migration guide for register{StandardSchemes => SchemesAsPrivileged} ( #16762 )
...
* docs: migration guide for register{StandardSchemes => SchemesAsPrivileged}
cc @nitsakh
* Update docs/api/protocol.md
Co-Authored-By: nornagon <nornagon@nornagon.net>
* Update docs/api/protocol.md
Co-Authored-By: nornagon <nornagon@nornagon.net>
* Update protocol.md
* Update docs/api/protocol.md
Co-Authored-By: nornagon <nornagon@nornagon.net>
2019-02-12 04:31:53 -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
Shelley Vohr
1f2b02c18f
feat: promisify protocol.isProtocolHandled() ( #16423 )
...
* feat: promisify protocol
* fix base::Bind and specs
* update documentation
* make callback-compatible
* async awaitify tests
2019-01-17 09:05:10 -08:00
David Baker
cc85946f55
feat: Support response headers in File protocol handler ( #16098 )
...
* feat: Support response headers in File protocol handler
* bugfix: Null check headers value & fix tests
* refactor: Use non-deprecated FindKeyOfType
2018-12-18 23:17:02 -07:00
David Sanders
bae652f46d
docs: http protocol handlers can access headers ( #15431 )
...
* test: check http protocol handlers can access headers
* docs: http protocol handlers can access headers
2018-10-30 11:37:49 -07:00
David Sanders
c93973ab7a
docs: fix protocol.isProtocolHandled documentation ( #15430 )
2018-10-29 15:23:23 -04:00
Samuel Attard
558fff69e7
chore: update to standard 12
2018-09-14 14:57:01 +10:00
Toinane
0a0d88a5dc
remove all double spaces not needed
2017-11-29 11:58:24 +01:00
Thiago de Arruda
5e8618ec3b
Add documentation for {intercept,register}StreamProtocol.
2017-11-13 16:16:14 -03:00
Zeke Sikelianos
3d2c622ba7
use new Buffer.from
2017-06-10 12:22:27 -07:00
Zeke Sikelianos
e57cb713b2
link process annotations to glossary
2016-12-21 13:47:40 -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
Kevin Sawicki
c5097ae483
Add options to protocol.registerStandardSchemes docs
2016-12-20 09:44:58 -08:00
Samuel Attard
06960704c4
Update docs for dts again
2016-11-25 23:17:31 +11:00
Zeke Sikelianos
ac68de6215
document process(es) for all APIs
2016-11-03 10:26:00 -07:00
tinydew4
67a09d9fe0
Fix typo, and trimming.
2016-10-24 06:34:09 +00:00
Samuel Attard
20323e7032
Specifiy function param types in docs
2016-10-13 17:30:57 +11:00
Samuel Attard
e0e47ea9a1
Update docs to contain more specific return values
2016-09-28 18:28:44 +13:00
deepak1556
ad783652c8
update docs
2016-09-22 00:20:34 +05:30
deepak1556
7b85ca0301
create helper class to read blob data
2016-09-01 08:52:44 +05:30
deepak1556
be4bc6b7ef
fix docs and update specs
2016-09-01 01:01:52 +05:30
deepak1556
a23e7ecf8f
add docs
2016-09-01 01:01:52 +05:30