deborator - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

		{
		"name": "deborator",
		"version": "1.0.0",
		"version": "1.0.1",
		"description": "a TypeScript decorator, to add console.log() to all methods and properties of a class.",
		@@ -5,0 +5,0 @@ "main": "deborator.ts",

README.md

		@@ -1,9 +0,54 @@
		# demo app
		# deborator readme

		based on app skeleton by Jack Franklin.
		deborator (DEBug decORATOR) is a TypeScript decorator, to add console.log() to all methods and properties of a class.

		## React + TypeScript + Jest demo app
		if you find yourself writing a lot of console.log() entries during debugging, then deborator may save you some time!

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

		- `yarn install`
		- `yarn start`
		- `open http://localhost:3000`
		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

		```
		import { deborator } from "./deborator";

		@deborator
		class MyClass {
		myMethod() {
		// ...
		}
		}
		```

		## running the demo app

		### 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
		```

		### running the app

		```
		run
		```

		## license

		MIT

New alerts