deborator

deborator readme

deborator (DEBug decORATOR) is a TypeScript decorator, to add console.log() to all methods and properties of a TypeScript class.

If you find yourself writing a lot of console.log() entries during debugging, then deborator may save you time!

This can be especially useful when regular debugging via breakpoints is not really practical

examples:

• developing drag'n'drop features in a browser since browsers like Chrome tend not to exit the 'dragging' state, if they hit a breakpoint

• developing real-time sites, when debugging via breakpoints is not practical

note: deborator should NOT be deployed to Production (as there may be performance/security impact because of the logging)

usage

Install deborator via yarn:

yarn add deborator

Import deborator into the TypeScript file, and apply the decorator to the class you want to debug:

import { deborator } from "deborator";

@deborator
class MyCalculator {
    add(value: number) {
        // ...
    }
}

Now if you hit F12, you will see console log entries for your class:

>DB> new MyCalculator( 1 )
>DB> MyCalculator.add( 5 )
>DB>   MyCalculator.add( 5 ) => ( {"value":6} )

running the demo app

To see deborator in action, you can get the source code and run the demo app.

• get the source code:

git clone https://bitbucket.org/str/deborator

dependencies

• node [v6.10.3 is OK]
• yarn [0.27.5 is OK]

setup

On a Windows box (Unix should be similar ...)

CD demo-app
install

run the app

run

relevant links

sourcecode in git: https://bitbucket.org/str/deborator

npm package: https://www.npmjs.com/package/deborator

TypeScript decorators:

license

MIT