0.2.0 • Published 1 year ago

@xhudaman/ws-console v0.2.0

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

ws-console

Console override for sending logs to a websocket server.

How to use

Installation

pnpm

  pnpm add @xhudaman/ws-console

npm

  npm i -s @xhudaman/ws-console

yarn

  yarn add @xhudaman/ws-console

Example Usage

import WSConsole from "@xhudaman/ws-console";

const wsConsole = WSConosle({
  // Use the address of your debug server if it differs from the example
  debugServerUrl: "ws://localhost:3001",
  enableInProduction: true,
});

Configuration

KeyRequiredDefault ValueAccepted Values
debugServerUrltrueN/AAny valid WebSocket URL. For example: ws://domain:port or wss://domain:port
enableInProductionfalsefalsetrue or false
enableConsoleOverridesfalsetruetrue or false
disablePassthroughToNativeConsolefalsefalsetrue or false

Warning: If you are using this package on the Switch in the skyline-web browser, you must set disablePassthroughToNativeConsole to true or it will block the remainder of the code running in the same scope.