Ionic-debug-console NPM

Ionic Debug Console

In-app javascript console for Ionic 2 applications with remote error tracking.

Installation

Run this command in root of your Ionic 2 project.

To install this library, run:

$ npm install ionic-debug-console --save

Then require the console library in app.ts.

import * as cons from 'ionic-debug-console/ionic-debug-console';

Add Ionic Debug Console button directive to @Component metadata in app.ts:

@Component({
  templateUrl: 'build/app.html',
  directives: [cons.ConsoleButtonComponent]
})

Pass ConsoleDataProvider instance to @Component class constructor and init console with some config.

constructor(private consoleDataProvider: cons.ConsoleDataProvider){
  this.consoleDataProvider.init({apiUrl: 'http://localhost:3000/',
                                  apiToken: '574a946146bab50828200f3e',
                                  reporting: true});
}

Add Ionic Debug Console providers to ionicBootstrap function:

ionicBootstrap(AppClass,
               [cons.ConfProvider,
                cons.ConsoleDataProvider,
                cons.AppConsoleService,
                cons.SystemInfoProvider], {}
              );

Put console button component to @Component template in app.html. Don`t forget pass content.

<console-button [content]="content"></console-button>

Example application with integration described above:

https://github.com/lpikora/ionic-conference-app

Configuration

Configuration is pass as object with properties to init function of ConsoleDataProvider. For example:

  this.consoleDataProvider.init({apiUrl: 'http://localhost:3000/',
                                  apiToken: '574a946146bab50828200f3e',
                                  reporting: true});

When reporting set true, some configuration values are load from server application settings. Values passed to init() function has always prioprity and rewrite application configuration from server.

apiUrl - url of server running Ionic Debug Console Server
apiToken - application accest token for server
reporting - when true, logged data are sent to server. Default false.
production - when true, console button will not show and console errors, logs and warns are disabled. Default false.
communicationInterval - interval in ms for sending dat to server. Default value loads from server.
logErrors - when true, errors aer sent to server. Default value loads from server.
logWarnings - when true, console.warn output is sent to server. Default value loads from server.
logLogs - when true, console.log output is sent to server. Default value loads from server.
sendOnlyOnError - when true, console output is sent only if contains error. Default value loads from server.