### Install @simplex2-sdk-util/console Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=readme This command installs the @simplex2-sdk-util/console package using npm. It is the first step to using the library in your project. ```bash npm install @simplex2-sdk-util/console ``` -------------------------------- ### Console Logging Methods (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=dependencies Examples of using common console logging methods like log, info, warn, and error provided by the @simplex2-sdk-util/console library. ```javascript console.log('Hello World!') ``` ```javascript console.info('Hello World!') ``` ```javascript console.warn('Hello World!') ``` ```javascript console.error('Hello World!') ``` -------------------------------- ### Create Console Object (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=readme Demonstrates how to create a new console object using the @simplex2-sdk-util/console library without the SimpleX2 plugin creator. This is a basic setup for direct usage. ```javascript // console.js import Console from '@simplex2-sdk-util/console' // Create a new console object whitout SimpleX2 plugin creator const console = new Console() ``` -------------------------------- ### Vue Plugin for Console (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=readme Shows how to integrate the @simplex2-sdk-util/console library as a Vue plugin using the pluginsManager. This example covers configuration for Vue 2 and Vue 3 main.js files. ```javascript // console.js import Console from '@simplex2-sdk-util/console' import pluginsManager from '@simplex2-sdk-util/plugins-manager' pluginsManager.addVuePlugin('console', { hangInWindow: true, install: true, hangInWindowName: 'simplex2UtilSDKConsole', hangInVueName: '$consoleSDK', plugin: (that, Vue, options) => { return new Console(options) } }) // in Vue2 main.js import Vue from 'vue' import App from './App.vue' import console from './console' Vue.use(console) new Vue({ render: h => h(App) }).$mount('#app') // end Vue2 main.js /* --- or --- */ // in Vue3 main.js import { createApp } from 'vue' import App from './App.vue' import console from './console' const app = createApp(App) app.use(console) app.mount('#app') // end Vue3 main.js ``` -------------------------------- ### Console Log Method Usage (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=code Example of using the 'log' method provided by the console object from @simplex2-sdk-util/console. This method is used for general outputting of information to the console. ```javascript console.log('Hello World!') ``` -------------------------------- ### Console Open Method Usage (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=code Example of calling the 'open' method on a console object created with @simplex2-sdk-util/console. This method is likely used to make the console visible or active. ```javascript console.open() ``` -------------------------------- ### Integrate Console with Vue 3 Plugin (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=code Demonstrates integrating the @simplex2-sdk-util/console library with a Vue 3 application. It uses Vue 3's createApp and app.use() method for plugin installation, enabling console functionality within the Vue app. ```javascript // in Vue3 main.js import { createApp } from 'vue' import App from './App.vue' import console from './console' const app = createApp(App) app.use(console) app.mount('#app') // end Vue3 main.js ``` -------------------------------- ### Console Get Console State Method (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=code Shows how to use the 'getConsoleState' method of the console object from @simplex2-sdk-util/console. This method returns a boolean indicating the current state of the console. ```javascript console.getConsoleState() // return // true ``` -------------------------------- ### Console Error Method Usage (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=code Shows an example of using the 'error' method provided by the @simplex2-sdk-util/console utility. This method is for logging errors and is typically displayed prominently in console output. ```javascript console.error('Hello World!') ``` -------------------------------- ### Integrate Console with Vue 2 Plugin (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=code Shows how to integrate the @simplex2-sdk-util/console library as a Vue 2 plugin using the pluginsManager. This setup allows for console access within Vue components via '$consoleSDK' and provides configuration options like 'hangInWindow'. ```javascript // console.js import Console from '@simplex2-sdk-util/console' import pluginsManager from '@simplex2-sdk-util/plugins-manager' pluginsManager.addVuePlugin('console', { hangInWindow: true, install: true, hangInWindowName: 'simplex2UtilSDKConsole', hangInVueName: '$consoleSDK', plugin: (that, Vue, options) => { return new Console(options) } }) // in Vue2 main.js import Vue from 'vue' import App from './App.vue' import console from './console' Vue.use(console) new Vue({ render: h => h(App) }).$mount('#app') // end Vue2 main.js ``` -------------------------------- ### Console Constructor and Options Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/index Describes how to instantiate the Console object and the available configuration options. The constructor can accept an options object to customize its behavior. ```APIDOC ## Console Constructor and Options ### Description Instantiate the Console object. You can provide an options object to customize its behavior. ### Method `new Console(options)` ### Parameters #### Request Body (Options Object) - **level** (string) - Optional - Default: 'info'. The default level for console messages. - **allowLevel** (array) - Optional - Default: ['log', 'info', 'warn', 'error']. An array of allowed logging levels. - **coverConsoleMethods** (boolean) - Optional - Default: true. If true, overrides `window.console` methods. - **logDate** (boolean) - Optional - Default: true. If true, includes the date in log output. - **logTime** (boolean) - Optional - Default: true. If true, includes the time in log output. - **dateFormatter** (string) - Optional - Default: 'YYYY-MM-DD'. Format for the date. - **timeFormatter** (string) - Optional - Default: 'HH:mm:ss'. Format for the time. - **upload** (boolean) - Optional - Default: false. If true, enables uploading console logs. - **uploadMethod** (function) - Optional - Default: `() => {}`. A function to handle log uploading. - **switchConsole** (boolean) - Optional - Default: true. Enables or disables console switching. ### Request Example ```javascript const console = new Console({ level: 'warn', logDate: false }); ``` ### Response #### Success Response (Instance) - **Console Instance** - A new instance of the Console object. #### Response Example ```javascript // Returns a Console instance ``` ``` -------------------------------- ### Console Object Initialization Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console Demonstrates how to create a new console object, both with and without the SimpleX2 plugin creator. ```APIDOC ## Console Object Initialization ### Description Instantiate the Console class to create a new console object. ### Method `new Console(options?)` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body * **options** (object) - Optional - Configuration options for the console. * **level** (string) - 'log' | 'info' | 'warn' | 'error' - Default: 'info'. The minimum level of messages to be logged. * **allowLevel** (array of strings) - Array of logging levels to allow. Default: ['log', 'info', 'warn', 'error']. * **coverConsoleMethods** (boolean) - If true, will override the native `window.console` methods. Default: true. * **logDate** (boolean) - If true, the date will be included in log messages. Default: true. * **logTime** (boolean) - If true, the time will be included in log messages. Default: true. * **dateFormatter** (string) - Format string for the date. Default: 'YYYY-MM-DD'. * **timeFormatter** (string) - Format string for the time. Default: 'HH:mm:ss'. * **upload** (boolean) - If true, enables uploading console logs. Default: false. * **uploadMethod** (function) - A callback function to handle log uploading. Default: `() => {}`. * **switchConsole** (boolean) - Enables or disables console switching functionality. Default: true. ### Request Example ```javascript // Without options const console = new Console(); // With options const options = { level: 'warn', logDate: false }; const consoleWithOptions = new Console(options); ``` ### Response #### Success Response (200) * **Console instance** (object) - A new instance of the Console class. ``` -------------------------------- ### Console Options Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=dependents Configuration options for initializing and customizing the console's behavior. ```APIDOC ## Console Options ### Description Customize the behavior of the console with the following options during initialization. ### Default Options ```javascript { level: 'info', // default level: log < info < warn < error allowLevel: ['log', 'info', 'warn', 'error'], // default allowed log levels coverConsoleMethods: true, // if true, window.console object will be overridden logDate: true, // if true, the date will be included in log entries logTime: true, // if true, the time will be included in log entries dateFormatter: 'YYYY-MM-DD', // format for the date timeFormatter: 'HH:mm:ss', // format for the time upload: false, // if true, console output will be sent to uploadMethod uploadMethod: () => { /* custom upload logic */ }, // function to handle uploading logs switchConsole: true // enables or disables console switching } ``` ### Usage Example (with custom options) ```javascript import Console from '@simplex2-sdk-util/console'; const options = { level: 'warn', logDate: false, upload: true, uploadMethod: (logEntry) => { console.log('Uploading log:', logEntry); // Implement your upload logic here } }; const console = new Console(options); ``` ``` -------------------------------- ### Console Open/Close and State Check (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=dependencies Demonstrates the usage of `open`, `close`, and `getConsoleState` methods for managing the console's visibility and checking its current status. ```javascript console.open() ``` ```javascript console.close() ``` ```javascript console.getConsoleState() // return // true ``` -------------------------------- ### Default Console Options Configuration Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=dependencies Illustrates the default configuration options available for the Console object. These options control logging levels, date/time formatting, and upload behavior. ```javascript options = { level: 'info', // default level this is the default level of the console => log < info < warn < error allowLevel: ['log', 'info', 'warn', 'error'], // default allowLevel coverConsoleMethods: true, // default coverConsoleMethods if true, window.console object will be covered logDate: true, // default logDate if true, the date will be logged logTime: true, // default logTime if true, the time is logged dateFormatter: 'YYYY-MM-DD', // default dateFormatter timeFormatter: 'HH:mm:ss', // default timeFormatter upload: false, // default upload if true, the console will be use uploadMethod uploadMethod: () => { }, switchConsole: true // default switchConsole } ``` -------------------------------- ### Console Methods Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console Provides details on the various methods available on the Console instance for logging and controlling console behavior. ```APIDOC ## Console Methods ### Description These methods are available on the Console instance for logging messages and managing the console's state. ### log Logs a message to the console. ### info Logs an informational message to the console. ### warn Logs a warning message to the console. ### error Logs an error message to the console. ### open Opens the console interface. ### close Closes the console interface. ### getConsoleState Retrieves the current state of the console. #### Request Example ```javascript console.log('This is a log message.'); console.info('This is an info message.'); console.warn('This is a warning message.'); console.error('This is an error message.'); console.open(); const state = console.getConsoleState(); // true or false console.close(); ``` #### Response Example (getConsoleState) ```json true ``` ``` -------------------------------- ### Console API Methods (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=readme Illustrates the usage of various methods available on the console object, including logging functions (log, info, warn, error), and control methods (open, close, getConsoleState). ```javascript console.log('Hello World!') console.info('Hello World!') console.warn('Hello World!') console.error('Hello World!') console.open() console.close() console.getConsoleState() // return // true ``` -------------------------------- ### Console Info Method Usage (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=code Demonstrates the usage of the 'info' method from the @simplex2-sdk-util/console library. This method is typically used for informational messages, often styled differently in console output. ```javascript console.info('Hello World!') ``` -------------------------------- ### Default Console Options (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=readme Defines the default configuration options for the console object, including logging level, allowed levels, console method covering, date/time logging, formatting, upload functionality, and console switching. ```javascript options = { level: 'info', // default level this is the default level of the console => log < info < warn < error allowLevel: ['log', 'info', 'warn', 'error'], // default allowLevel coverConsoleMethods: true, // default coverConsoleMethods if true, window.console object will be covered logDate: true, // default logDate if true, the date will be logged logTime: true, // default logTime if true, the time will be logged dateFormatter: 'YYYY-MM-DD', // default dateFormatter timeFormatter: 'HH:mm:ss', // default timeFormatter upload: false, // default upload if true, the console will be use uploadMethod uploadMethod: () => { }, switchConsole: true // default switchConsole } ``` -------------------------------- ### Console Class Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=code The main Console class for the SimpleX2-SDK-Util Console library. ```APIDOC ## Console Class ### Description This class provides utility methods for console manipulation. ### Constructor ```javascript new Console(options) ``` Creates a new Console object. Accepts an optional `options` object to customize behavior. ### Methods #### log ```javascript console.log(message) ``` Logs a message to the console. #### info ```javascript console.info(message) ``` Logs an informational message to the console. #### warn ```javascript console.warn(message) ``` Logs a warning message to the console. #### error ```javascript console.error(message) ``` Logs an error message to the console. #### open ```javascript console.open() ``` Opens the console. #### close ```javascript console.close() ``` Closes the console. #### getConsoleState ```javascript console.getConsoleState() ``` Returns the current state of the console (true if open, false if closed). ### Options Default options are: ```javascript { level: 'info', // default level this is the default level of the console => log < info < warn < error allowLevel: ['log', 'info', 'warn', 'error'], // default allowLevel coverConsoleMethods: true, // default coverConsoleMethods if true, window.console object will be covered logDate: true, // default logDate if true, the date will be logged logTime: true, // default logTime if true, the time will be logged dateFormatter: 'YYYY-MM-DD', // default dateFormatter timeFormatter: 'HH:mm:ss', // default timeFormatter upload: false, // default upload if true, the console will be use uploadMethod uploadMethod: () => {}, switchConsole: true // default switchConsole } ``` ``` -------------------------------- ### Console Methods Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/index Details the various methods available on the Console object for logging, controlling console state, and retrieving its status. ```APIDOC ## Console Methods ### Description Provides methods to interact with the console, including logging messages, opening/closing the console, and checking its state. ### Methods #### `log(message)` Logs a message to the console with the 'log' level. ##### Example ```javascript console.log('Hello World!'); ``` #### `info(message)` Logs a message to the console with the 'info' level. ##### Example ```javascript console.info('Hello World!'); ``` #### `warn(message)` Logs a message to the console with the 'warn' level. ##### Example ```javascript console.warn('Hello World!'); ``` #### `error(message)` Logs a message to the console with the 'error' level. ##### Example ```javascript console.error('Hello World!'); ``` #### `open()` Opens the console interface. ##### Example ```javascript console.open(); ``` #### `close()` Closes the console interface. ##### Example ```javascript console.close(); ``` #### `getConsoleState()` Retrieves the current state of the console (open or closed). ##### Returns - **boolean**: `true` if the console is open, `false` otherwise. ##### Example ```javascript const isOpen = console.getConsoleState(); console.log(isOpen); // true or false ``` ``` -------------------------------- ### Console Object Methods Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=dependencies This section details the methods available on the Console object for manipulating and interacting with the console. ```APIDOC ## Console Methods ### log Logs a message to the console. - **Method**: N/A (Instance method) - **Endpoint**: N/A - **Parameters**: None - **Request Example**: `console.log('Hello World!')` - **Response**: None ### info Logs an informational message to the console. - **Method**: N/A (Instance method) - **Endpoint**: N/A - **Parameters**: None - **Request Example**: `console.info('Hello World!')` - **Response**: None ### warn Logs a warning message to the console. - **Method**: N/A (Instance method) - **Endpoint**: N/A - **Parameters**: None - **Request Example**: `console.warn('Hello World!')` - **Response**: None ### error Logs an error message to the console. - **Method**: N/A (Instance method) - **Endpoint**: N/A - **Parameters**: None - **Request Example**: `console.error('Hello World!')` - **Response**: None ### open Opens the console. - **Method**: N/A (Instance method) - **Endpoint**: N/A - **Parameters**: None - **Request Example**: `console.open()` - **Response**: None ### close Closes the console. - **Method**: N/A (Instance method) - **Endpoint**: N/A - **Parameters**: None - **Request Example**: `console.close()` - **Response**: None ### getConsoleState Retrieves the current state of the console. - **Method**: N/A (Instance method) - **Endpoint**: N/A - **Parameters**: None - **Request Example**: `console.getConsoleState()` - **Response Example**: `true` (returns boolean) ``` -------------------------------- ### Console Options Configuration (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=code Defines the default options object for the @simplex2-sdk-util/console library. This object allows customization of logging levels, date/time formatting, console method overriding, and upload functionality. ```javascript options = { level: 'info', allowLevel: ['log', 'info', 'warn', 'error'], coverConsoleMethods: true, logDate: true, logTime: true, dateFormatter: 'YYYY-MM-DD', timeFormatter: 'HH:mm:ss', upload: false, uploadMethod: () => { }, switchConsole: true } ``` -------------------------------- ### Console Methods API Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=versions This section describes the various methods available on the Console object for interacting with and manipulating the console output. ```APIDOC ## Console Methods API ### Description This API provides methods to control and interact with the console. ### Methods #### `log(message)` ##### Description Logs a message to the console. ##### Method `log` ##### Parameters - **message** (string) - The message to log. ##### Request Example ```javascript console.log('Hello World!') ``` #### `info(message)` ##### Description Logs an informational message to the console. ##### Method `info` ##### Parameters - **message** (string) - The message to log. ##### Request Example ```javascript console.info('Hello World!') ``` #### `warn(message)` ##### Description Logs a warning message to the console. ##### Method `warn` ##### Parameters - **message** (string) - The message to log. ##### Request Example ```javascript console.warn('Hello World!') ``` #### `error(message)` ##### Description Logs an error message to the console. ##### Method `error` ##### Parameters - **message** (string) - The message to log. ##### Request Example ```javascript console.error('Hello World!') ``` #### `open()` ##### Description Opens the console. ##### Method `open` ##### Request Example ```javascript console.open() ``` #### `close()` ##### Description Closes the console. ##### Method `close` ##### Request Example ```javascript console.close() ``` #### `getConsoleState()` ##### Description Gets the current state of the console. ##### Method `getConsoleState` ##### Response - **state** (boolean) - `true` if the console is open, `false` otherwise. ##### Response Example ```json true ``` ``` -------------------------------- ### Console Options Configuration Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console This object defines the default options for the Console utility. It covers logging levels, date/time formatting, console method overriding, and upload functionality. ```javascript options = { level: 'info', // default level this is the default level of the console => log < info < warn < error allowLevel: ['log', 'info', 'warn', 'error'], // default allowLevel coverConsoleMethods: true, // default coverConsoleMethods if true, window.console object will be covered logDate: true, // default logDate if true, the date will be logged logTime: true, // default logTime if true, the time will be logged dateFormatter: 'YYYY-MM-DD', // default dateFormatter timeFormatter: 'HH:mm:ss', // default timeFormatter upload: false, // default upload if true, the console will be use uploadMethod uploadMethod: () => { }, switchConsole: true // default switchConsole } ``` -------------------------------- ### Console Object Methods Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=dependents This section details the methods available on the Console object for logging, managing console state, and controlling its visibility. ```APIDOC ## Console Object Methods ### Description Provides methods for interacting with and controlling the console. ### Methods #### `log(message)` Logs a message to the console. - **message** (string) - The message to log. ### Request Example ```javascript console.log('Hello World!') ``` #### `info(message)` Logs an informational message to the console. - **message** (string) - The message to log. ### Request Example ```javascript console.info('Hello World!') ``` #### `warn(message)` Logs a warning message to the console. - **message** (string) - The message to log. ### Request Example ```javascript console.warn('Hello World!') ``` #### `error(message)` Logs an error message to the console. - **message** (string) - The message to log. ### Request Example ```javascript console.error('Hello World!') ``` #### `open()` Opens the console interface. ### Request Example ```javascript console.open() ``` #### `close()` Closes the console interface. ### Request Example ```javascript console.close() ``` #### `getConsoleState()` Retrieves the current state of the console (open or closed). ### Response #### Success Response (200) - **state** (boolean) - `true` if the console is open, `false` otherwise. ### Response Example ```json { "state": true } ``` ``` -------------------------------- ### Console Options Configuration (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=dependents This JavaScript object defines the default options for the Console utility. It includes settings for log levels, date/time formatting, console method overriding, and upload functionality. ```javascript options = { level: 'info', // default level this is the default level of the console => log < info < warn < error allowLevel: ['log', 'info', 'warn', 'error'], // default allowLevel coverConsoleMethods: true, // default coverConsoleMethods if true, window.console object will be covered logDate: true, // default logDate if true, the date will be logged logTime: true, // default logTime if true, the time is logged dateFormatter: 'YYYY-MM-DD', // default dateFormatter timeFormatter: 'HH:mm:ss', // default timeFormatter upload: false, // default upload if true, the console will be use uploadMethod uploadMethod: () => { }, switchConsole: true // default switchConsole } ``` -------------------------------- ### Console Warn Method Usage (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=code Illustrates how to use the 'warn' method of the console object from @simplex2-sdk-util/console. This method is intended for warning messages, which are usually highlighted in console interfaces. ```javascript console.warn('Hello World!') ``` -------------------------------- ### Console Close Method Usage (JavaScript) Source: https://www.npmjs.com/package/@simplex2-sdk-util/console/package/%40simplex2-sdk-util/console_activetab=code Demonstrates the usage of the 'close' method for a console object from @simplex2-sdk-util/console. This method presumably deactivates or hides the console. ```javascript console.close() ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.