Skip to content

Commit 00885ec

Browse files
patinthehatPatrick
authored andcommitted
update readme with nodeRaySettings config option and examples
1 parent 5f23aea commit 00885ec

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,14 @@ const { RayPlugin } = require('vue-ray');
4545

4646
const app = createApp(App);
4747

48-
app.use(RayPlugin, { interceptErrors: true, port: 23500, showComponentEvents: ['created', 'mounted'] });
48+
app.use(RayPlugin, {
49+
interceptErrors: true,
50+
port: 23500,
51+
showComponentEvents: ['created', 'mounted'],
52+
nodeRaySettings: {
53+
interceptConsoleLog: true,
54+
},
55+
});
4956
```
5057

5158
### Installing in Vue 2
@@ -61,7 +68,14 @@ import { RayPlugin } from 'vue-ray/vue2';
6168
// or as a commonjs import:
6269
const { RayPlugin } = require('vue-ray/vue2');
6370

64-
Vue.use(RayPlugin, { interceptErrors: true, host: '127.0.0.1', showComponentEvents: ['mounted'] });
71+
Vue.use(RayPlugin, {
72+
interceptErrors: true,
73+
host: '127.0.0.1',
74+
showComponentEvents: ['mounted'],
75+
nodeRaySettings: {
76+
interceptConsoleLog: false,
77+
},
78+
});
6579
```
6680

6781
### Installation options
@@ -72,6 +86,7 @@ Vue.use(RayPlugin, { interceptErrors: true, host: '127.0.0.1', showComponentEven
7286
| `interceptErrors` | `boolean` | `false` | send Vue errors to Ray |
7387
| `port` | `number` | `23517` | port to connect to the Ray app on |
7488
| `showComponentEvents` | `string[]` | `[]` | display component events in Ray, see below for possible values |
89+
| `nodeRaySettings` | `object` | `{}` | pass additional settings for `node-ray` _[(reference)](https://github.com/permafrost-dev/node-ray#reference))_ |
7590

7691
### Component events
7792

0 commit comments

Comments
 (0)