Giter VIP home page Giter VIP logo

express-console-warning's Introduction

express-console-warning

Express middleware for console-warning.

Installation

v1.x

npm install --save [email protected]

v2.x

npm install --save [email protected]

Usage

v1.x

var express = require('express');
var interceptor = require('express-console-warning');
var app = express();

app.use(interceptor);
app.get('/', function(req, res){
    res.sendFile(path.join(__dirname, './index.html'));
});

v2.x

var express = require('express');
var hiringAtConsole = require('express-console-warning');
var app = express();

app.use(hiringAtConsole.LOG('We\'re hiring http://hiring.me')
                       .text('Come Join Us', {color: 'blue'})
                       .build());

// or

app.use(hiringAtConsole.default()); //fallback to v1.x

Explanation

v1.x

What this middleware will do is to inject <script src="https://cdn.rawgit.com/tanhauhau/console-warning/master/warning.min.js" type="text/javascript"></script> into any reply that delivers html page. So the script will run and log a warning sign in your console.

v2.x

What this middleware will do is inject a <script> tag with console-warning script into your html document <body>. It won't pollute your global namespace, so you don't have to worry about it.

Documentation

var konsole = require('express-console-warning');

  • konsole.default() - Print out the same message as for v1.x

The following method is chainable and must call .build() in the end:

  • konsole.log(text) - Log a normal text to console
  • konsole.LOG(text) - Log a big text to console
  • konsole.warn(text) - Warn a normal text to console
  • konsole.WARN(text) - Warn a big text to console, with red background and yello font
  • konsole.image(url, scale) - Print image to console
  • konsole.text(text, attr) - Log a text with specified attributes to console.
    • Available attributes: background,color,fontSize, use it as you would for css styling

License

The MIT License (MIT)

Copyright (c) 2016 Tan Li Hau

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

express-console-warning's People

Contributors

tanhauhau avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.