mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

feat: allow setting capture mode and max file size in netLog API (#19215)

Browse source
This commit is contained in:
Jeremy Apthorp 2019-07-25 16:06:39 -07:00 • committed by GitHub
commit 477661d0e4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 102 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/api/net-log.md
View file

@ -22,9 +22,17 @@ of the `app` module gets emitted.
## Methods
### `netLog.startLogging(path)`
### `netLog.startLogging(path[, options])`
* `path` String - File path to record network logs.
* `options` Object (optional)
* `captureMode` String (optional) - What kinds of data should be captured. By
default, only metadata about requests will be captured. Setting this to
`includeSensitive` will include cookies and authentication data. Setting
it to `everything` will include all bytes transferred on sockets. Can be
`default`, `includeSensitive` or `everything`.
* `maxFileSize` Number (optional) - When the log grows beyond this size,
logging will automatically stop. Defaults to unlimited.
Returns `Promise<void>` - resolves when the net log has begun recording.