Skip to content

Commit b48f925

Browse files
committed
docs: update README.md
1 parent 4ffb8ee commit b48f925

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,21 @@ if (isDev) {
4444

4545
## Devtron API
4646

47-
### `await devtron.install()`
47+
### `await devtron.install(options)`
4848

4949
Installs Devtron into the Electron app. Refer to [Configuring an Electron App to use Devtron](#configuring-an-electron-app-to-use-devtron) for installation instructions.
5050

51+
#### `Options`
52+
53+
| Option | Type | Default | Description |
54+
| ------------ | ----------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------- |
55+
| `quiet` | `boolean` | `false` | Suppresses all logs except `error` level logs from appearing in the terminal. Precisely, it ignores `debug`, `info`, and `warn` logs. |
56+
| `ignoreLogs` | `Array<'debug' \| 'info' \| 'warn' \| 'error'>` | `undefined` | List of log levels to ignore, e.g. `['debug', 'info']`. Overrides the `quiet` option if both are set. |
57+
58+
```js
59+
await devtron.install({ quiet: true });
60+
```
61+
5162
### `await devtron.getEvents()`
5263

5364
Returns a **promise** that resolves to the array of IPC events recorded by the Devtron service worker since installation.

0 commit comments

Comments
 (0)