log-dot-js
Version:
A logger that you can utilise within your projects
107 lines (64 loc) • 1.69 kB
Markdown
# Log.js
A logger that you can utilise within your projects
# Instructions
### Instalation
```
var log = require('log-dot-js')
```
### Print
This is used to simply print a message along with your local time next to it without any color
Usage:
```
log.print("Your message");
```
Output:
### Info
This is used to display any sort of information you would like the user to know about
Usage:
```
log.info("Some information");
```
Output:
### Success
This is used to show the user a task has been succesfully completed
Usage:
```
log.success("Some operation completed successfully");
```
Output:
### Warning
This is used to display a warning
Usage:
```
log.warn("Some warning");
```
Output:
### Message
Use this to display any message.
This gets the message from the specified url.
```
var log = require('log-dot-js');
log.message("yoururlhere.domain");
```
### Write File
Use this to store logs in a file.
<br>The text is kept in a file and is overrun once the app is started again
<br>You can use this multiple times within the file .
Usage:
```
log.writeFile("Info that you want to store");
```
### Welcome
Use this for a welcome message.
<br>It will get your project name and version from the package.json.
<br>If you do not have a package.json file it will produce an error.
Usage:
```
log.welcome();
```
Output
