{"repo":"permafrost-dev/vue-ray","free":true,"listed":false,"github":"https://github.com/permafrost-dev/vue-ray","clone":"git clone https://github.com/permafrost-dev/vue-ray.git","description":"Debug your Vue 3 code with Ray to fix problems faster","language":"TypeScript","stars":85,"topics":["vue","vue2","vue3","debugging","vue-plugin","npm-package","ray-app","vuejs"],"license":"MIT","category":"dev-tools","readme_excerpt":"vue-ray vue-ray Debug Vue code with Ray to fix problems faster Install this package in any Vue 3 project to send messages to the Ray app. Installation Install with npm: or bun: Installing When using in a Vue 3 project, you may optionally install the plugin globally in your main.js or app.js file. This is primarily useful if you want to cusomize the connection settings for the package. Installation options Name Type Default Description --------------------- ---------- ----------- -------------------------------------------------------------- host string localhost host to connect to the Ray app on scheme string http URI scheme to use to connect to host interceptErrors boolean false send Vue errors to Ray port number 23517 port to connect to the Ray app on nodeRaySettings object {} pass additional settings for node-ray (reference) Usage To access the ray() function, import raySetup() from the vue-ray library: The raySetup() function accepts an optional options object, defined as: The lifecycleEvents object can be used to enable or disable sending of the component's lifecycle events to Ray. Use the all property to enable all lifecycle events. The following example will send the created and mounted events to Ray for the component: The connection object can be used to specify the host and port to connect to the Ray app. The default values are localhost and 23517 , respectively. Sending data to Ray Once you have called raySetup() , you may use the ray function in the Vue SFC as norm","default_branch":null,"files":null,"tree":[],"storefront":"/r/permafrost-dev","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/permafrost-dev/vue-ray/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}