Skip to content

Commit 09504c8

Browse files
committed
chore(docs): Mark file and remote transports as main proc only, closes #473
1 parent 4fa304d commit 09504c8

3 files changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ DevTools console (renderer process).
106106

107107
[Read more about console transport](docs/transports/console.md).
108108

109-
#### File transport
109+
#### File transport (main process only)
110110

111111
The file transport writes log messages to a file.
112112

@@ -128,12 +128,16 @@ It displays log messages from main process in the renderer's DevTools console.
128128
By default, it's disabled for a production build. You can enable in the
129129
production mode by setting the `level` property.
130130

131+
In the renderer process, this transport does the opposite: it sends the data
132+
to the main process via IPC. Then, the data is written to the console and
133+
the filesystem.
134+
131135

132136
##### Options
133137

134138
- **level**, default 'silly' in the dev mode, `false` in the production.
135139

136-
#### Remote transport
140+
#### Remote transport (main process only)
137141

138142
Sends a JSON POST request with `LogMessage` in the body to the specified url.
139143

docs/transports/file.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# File transport
1+
# File transport (main process only)
22

3-
The file transport writes log messages to a file.
3+
The file transport writes log messages to a file
44

55
## Options
66

docs/transports/remote.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Remote transport
1+
# Remote transport (main process only)
22

33
Sends a JSON POST request with `LogMessage` in the body to the specified url.
44

0 commit comments

Comments
 (0)