ThunderNetworkRaD/node-cout
2
0
Fork 0
Code Issues 4 Pull requests Projects Releases 11 Packages Wiki Activity Actions

Added Troubleshooting section

Browse source
This commit is contained in:
mambuco 2023-09-03 00:07:21 +02:00
parent 662b7ea482
commit 9494c7f1a1
1 changed files with 21 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
readme.md
View file

@ -1,4 +1,4 @@
# COUT # node-cout
This package allows you to use `cout` and debug levels in Node.js. This package allows you to use `cout` and debug levels in Node.js.
@ -17,13 +17,13 @@ Learn how to use `node-cout` here:
### Import ### Import
```js ```js
const cc = require('node-cout'); // CommonJS import cc from 'node-cout';
import cc from 'node-cout'; // MJS or TypeScript
const cout = new cc(1, { save: true, emoji: true, types: ['loading', 'uploading'] }); const cout = new cc(1, { save: true, emoji: true, types: ['loading', 'uploading'] });
``` ```
> You're using CommonJS and can use `require()` instead of `import`? Go on [troubleshooting](#troubleshooting).
> Parameters: > Parameters:
> ``` > ```
> debugLevel: number > debugLevel: number
@ -54,4 +54,20 @@ If you want to use the `types` option, you can do it like this:
cout.debug('Hello World', 1, types); cout.debug('Hello World', 1, types);
``` ```
`types` can either be a string or an array of strings, and if one of them matches with one of the types defined in the constructor, the log is going to be logged. `types` can either be a string or an array of strings, and if one of them matches with one of the types defined in the constructor, the log is going to be logged.
# Troubleshooting
Unfortunately, this is not supported anymore:
```js
const cc = require('node-cout');
```
If you want to `import` the package in your CommonJS project, add this to your `package.json` file:
```json
{
"type": "module"
}
```