https://github.com/adriancmiranda/trace
Displays expressions, or writes to log files, while debugging.
https://github.com/adriancmiranda/trace
console debug javascript logging trace
Last synced: over 1 year ago
JSON representation
Displays expressions, or writes to log files, while debugging.
- Host: GitHub
- URL: https://github.com/adriancmiranda/trace
- Owner: adriancmiranda
- License: mit
- Created: 2014-07-26T01:52:02.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2018-12-03T15:38:05.000Z (over 7 years ago)
- Last Synced: 2025-01-27T05:58:25.893Z (over 1 year ago)
- Topics: console, debug, javascript, logging, trace
- Language: JavaScript
- Homepage:
- Size: 117 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
trace
=====
> Displays expressions, or writes to log files, while debugging. A single trace statement can support multiple arguments. If any argument in a trace statement includes a data type other than a String, the trace function invokes the associated toString() method for that data type. For example, if the argument is a Boolean value the trace function invokes Boolean.toString() and displays the return value.
[![deps][deps]][deps-url]
[![depsci][depsci]][depsci-url]
[![travis][travis]][travis-url]
[![appveyor][appveyor]][appveyor-url]
[![circleci][circleci]][circleci-url]
[![codacy][codacy]][codacy-url]
## How to install __trace__ in your project
### bower
```bash
bower install --save-dev adriancmiranda/trace
```
### cdn
#### uncompressed
```javascript
```
#### compressed
```javascript
```
## Usage
Join `debug` query in URL (e.g. `?debug=*`) or set `console.enabled = true;` in your `JavaScript` code to show your logs and then use the [console](https://developer.mozilla.org/en/docs/Web/API/console) normally.
`P.S.` you can also usage the `trace` method as an alias to [console.log](https://developer.mozilla.org/en-US/docs/Web/API/Console/log) (:zap: flash feelings :sunglasses:)
### ⚫️ **trace(...arguments):void**
#### parameters
`... arguments` — One or more (comma separated) expressions to evaluate. For multiple expressions, a space is inserted between each expression in the output.
#### example
The following example uses the `trace()` method to print a simple string. Generally, the message will be printed to a _`Developer Tools > Console`_.
```javascript
trace("Hello", "World");
```
### ⚫️ **console.enabled:boolean**
A Boolean value that indicates whether the console is enabled.
### ⚫️ **console.history:array**
[read-only] Contents of the history stack
### ⚫️ **console.scrollback:uint**
The number of lines of scrollback buffer to keep above the visible part of the screen.
### ⚫️ **console.push(...arguments):void**
#### parameters
`... arguments` — One or more (comma separated) expressions to evaluate. For multiple expressions, a space is inserted between each expression in the output.
### ⚫️ **console.flush():void**
To clear the appended log with `console.push` method
## License
[MIT][license-url]
[deps]: https://david-dm.org/adriancmiranda/trace.svg
[deps-url]: https://david-dm.org/adriancmiranda/trace
[depsci]: https://dependencyci.com/github/adriancmiranda/trace/badge
[depsci-url]: https://dependencyci.com/github/adriancmiranda/trace
[travis]: https://travis-ci.org/adriancmiranda/trace.svg?branch=master
[travis-url]: https://travis-ci.org/adriancmiranda/trace
[appveyor]: https://ci.appveyor.com/api/projects/status/hucvow1n0t3q3le3/branch/master?svg=true
[appveyor-url]: https://ci.appveyor.com/project/adriancmiranda/trace/branch/master
[circleci]: https://circleci.com/gh/adriancmiranda/trace/tree/master.svg?style=shield
[circleci-url]: https://circleci.com/gh/adriancmiranda/trace/tree/master
[codacy]: https://api.codacy.com/project/badge/Grade/ac6b06afbcc14abd8ea55356adc45cd7
[codacy-url]: https://www.codacy.com/app/adriancmiranda/trace?utm_source=github.com&utm_medium=referral&utm_content=adriancmiranda/trace&utm_campaign=Badge_Grade
[license-url]: https://github.com/adriancmiranda/trace/blob/master/LICENSE