# @concepto/console

> Concepto DSL - visually create and maintain modern node.js based apps (@console)

Latest version **1.2.68** (published 2022-07-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @concepto/console
pnpm add @concepto/console
yarn add @concepto/console
bun add @concepto/console
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.68 |
| Published | 2022-07-26 |
| First published | 2021-12-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 44.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Pablo Schaffner |
| Maintainers | pabloschaffner |
| Keywords | creador, puntorigen, concepto, dsl, console |

## Links

- npm: https://www.npmjs.com/package/@concepto/console
- Repository: https://github.com/puntorigen4u/console
- Homepage: http://github.com/puntorigen4u/console.git
- Issues: http://github.com/puntorigen4u/console/issues
- npm.io page: https://npm.io/package/@concepto/console

## Dependencies (10)

- [ora](https://npm.io/package/ora.md) ^5.4.0
- [boxen](https://npm.io/package/boxen.md) ^4.2.0
- [colors](https://npm.io/package/colors.md) 1.4.0
- [ansicolor](https://npm.io/package/ansicolor.md) ^1.1.93
- [extractjs](https://npm.io/package/extractjs.md) ^0.3.1
- [strip-ansi](https://npm.io/package/strip-ansi.md) ^6.0.0
- [ascii-table](https://npm.io/package/ascii-table.md) 0.0.9
- [cli-progress](https://npm.io/package/cli-progress.md) ^3.9.0
- [clear-any-console](https://npm.io/package/clear-any-console.md) ^1.16.1
- [sort-objects-array](https://npm.io/package/sort-objects-array.md) ^1.7.1

## Recent versions

- 1.2.68 (latest) — 2022-07-26
- 1.2.67 — 2022-02-18
- 1.2.66 — 2022-02-18
- 1.2.65 — 2022-01-10
- 1.2.64 — 2021-12-12
- 1.2.63 — 2021-12-12
- 1.2.62 — 2021-12-12

## README

<p align="center">
  <a href="http://www.puntorigen.com/" target="blank"><img src="https://user-images.githubusercontent.com/57605485/144762579-7114f229-a01a-4afd-9a18-62ec3dbf3478.png" width="320" alt="Concepto DSL Logo" /></a>
</p>
<p align="center">A progressive <a href="http://nodejs.org" target="blank">Node.js</a> framework for visually building efficient and scalable nodejs based applications.</p>
<p align="center">
    <a href="https://www.npmjs.com/~concepto"><img src="https://img.shields.io/npm/v/@concepto/console.svg" alt="NPM Version" /></a>
    <a href="https://www.npmjs.com/~concepto"><img src="https://img.shields.io/npm/l/@concepto/console.svg" alt="Package License" /></a>
    <a href="https://www.npmjs.com/~concepto"><img src="https://img.shields.io/npm/dm/@concepto/console.svg" alt="NPM Downloads" /></a>
    <a href="https://www.npmjs.com/~concepto" target="_blank"><img src="https://img.shields.io/tokei/lines/github/puntorigen4u/console"></a>
    <a href="https://twitter.com/punt0rigen" target="_blank"><img src="https://img.shields.io/twitter/follow/punt0rigen.svg?style=social&label=Follow"></a>
</p>

## Description
Advanced ES6 console output class used within <a href="https://www.npmjs.com/package/@concepto/cli">Concepto DSL</a><br/>
Note you need to pass all arguments as an <i>object with keys</i>.

# API Reference
Open_console: A class to help display information in the console.


* [open_console](#module_open_console)
    * [.setSilent(value)](#module_open_console+setSilent)
    * [.time(id)](#module_open_console+time)
    * [.timeEnd(id, [data], [color], [prefix])](#module_open_console+timeEnd)
    * [.setPrefix([prefix], [color])](#module_open_console+setPrefix)
    * [.clear()](#module_open_console+clear)
    * [.spinner(message, [color], [prefix])](#module_open_console+spinner) ⇒ <code>Object</code>
    * [.progress(format, [config], [prefix], [formatData])](#module_open_console+progress) ⇒ <code>Object</code>
    * [.out(message, [data], [color], [prefix])](#module_open_console+out)
    * [.outT(message, [data], [color], [prefix])](#module_open_console+outT)
    * [.title(title, [color], [titleColor], [config])](#module_open_console+title)
    * [.table(title, data, [struct_sort], [color])](#module_open_console+table)

<a name="module_open_console+setSilent"></a>

### open_console.setSilent(value)
Sets visibility output

**Kind**: instance method of [<code>open\_console</code>](#module_open_console)  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>Boolean</code> | if true, hides all output |

<a name="module_open_console+time"></a>

### open_console.time(id)
Calls timer start

**Kind**: instance method of [<code>open\_console</code>](#module_open_console)  

| Param | Type | Description |
| --- | --- | --- |
| id | <code>String</code> | key ID to measure |

<a name="module_open_console+timeEnd"></a>

### open_console.timeEnd(id, [data], [color], [prefix])
Calls timer end

**Kind**: instance method of [<code>open\_console</code>](#module_open_console)  

| Param | Type | Description |
| --- | --- | --- |
| id | <code>String</code> | key ID to measure and show timming for. |
| [data] | <code>Object</code> | var dump to include in output |
| [color] | <code>String</code> | black,red,green,yellow,blue,purple,cyan,white |
| [prefix] | <code>String</code> | use this prefix instead of the configured one. To use color, use format 'prefix,color' |

<a name="module_open_console+setPrefix"></a>

### open_console.setPrefix([prefix], [color])
Sets output prefix

**Kind**: instance method of [<code>open\_console</code>](#module_open_console)  

| Param | Type | Description |
| --- | --- | --- |
| [prefix] | <code>String</code> | prefix |
| [color] | <code>String</code> | black,red,green,yellow,blue,purple,cyan,white |

<a name="module_open_console+clear"></a>

### open_console.clear()
Clears the console screen

**Kind**: instance method of [<code>open\_console</code>](#module_open_console)  
<a name="module_open_console+spinner"></a>

### open_console.spinner(message, [color], [prefix]) ⇒ <code>Object</code>
Outputs an ora spinner with the given message, used prefix and color.

**Kind**: instance method of [<code>open\_console</code>](#module_open_console)  
**Returns**: <code>Object</code> - - Object similar to ora object with an additional text(x) method  

| Param | Type | Description |
| --- | --- | --- |
| message | <code>String</code> | message to output |
| [color] | <code>String</code> | black,red,green,yellow,blue,purple,cyan,white |
| [prefix] | <code>String</code> | use this prefix instead of the configured one. To use color, use format 'prefix,color' |

<a name="module_open_console+progress"></a>

### open_console.progress(format, [config], [prefix], [formatData]) ⇒ <code>Object</code>
Returns an instance of cli-progress with the given total amount, format, and color.

**Kind**: instance method of [<code>open\_console</code>](#module_open_console)  
**Returns**: <code>Object</code> - - Object similar to cli-progress object with methods to create,update,remove progress bars  

| Param | Type | Description |
| --- | --- | --- |
| format | <code>String</code> | format of progress message. Example: 'Progress {bar} - {percentage} %' |
| [config] | <code>Object</code> | options overwrite for cli-progress multibar config |
| [prefix] | <code>String</code> | use this prefix instead of the configured one. To use color, use format 'prefix,color' |
| [formatData] | <code>function</code> | function(data) expects a return of a modified data instance. Inside you can control the format presentation and vars used inside the format argument. You also have access to special keys (progress,value,total,bar,eta,percentage,...all your data keys) and helper functions (data.funcs.colors and data.funcs.symbols). |

<a name="module_open_console+out"></a>

### open_console.out(message, [data], [color], [prefix])
Output a message to the console screen, with an optional var with data

**Kind**: instance method of [<code>open\_console</code>](#module_open_console)  

| Param | Type | Description |
| --- | --- | --- |
| message | <code>String</code> | message to output |
| [data] | <code>Object</code> | var dump to include in output |
| [color] | <code>String</code> | black,red,green,yellow,blue,purple,cyan,white |
| [prefix] | <code>String</code> | use this prefix instead of the configured one. To use color, use format 'prefix,color' |

<a name="module_open_console+outT"></a>

### open_console.outT(message, [data], [color], [prefix])
Output a message to the console screen with timestamp, and an optional var with data

**Kind**: instance method of [<code>open\_console</code>](#module_open_console)  

| Param | Type | Description |
| --- | --- | --- |
| message | <code>String</code> | message to output |
| [data] | <code>Object</code> | var dump to include in output |
| [color] | <code>String</code> | black,red,green,yellow,blue,purple,cyan,white |
| [prefix] | <code>String</code> | use this prefix instead of the configured one. To use color, use format 'prefix,color' |

<a name="module_open_console+title"></a>

### open_console.title(title, [color], [titleColor], [config])
Displays the given text as a title

**Kind**: instance method of [<code>open\_console</code>](#module_open_console)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| title | <code>String</code> |  | title to display |
| [color] | <code>String</code> | <code>white</code> | color for box borders. |
| [titleColor] | <code>String</code> |  | color for title. If undefined, uses the box color. |
| [config] | <code>Object</code> |  | config overwrite params for boxen. |
| [config.align] | <code>String</code> | <code>center</code> | aligns the title by its value: left,center,right |

<a name="module_open_console+table"></a>

### open_console.table(title, data, [struct_sort], [color])
Shows data array as table in the console

**Kind**: instance method of [<code>open\_console</code>](#module_open_console)  

| Param | Type | Description |
| --- | --- | --- |
| title | <code>String</code> | title for table |
| data | <code>Array</code> | array of objects for building the table. |
| [struct_sort] | <code>String</code> | sort data before displaying. Supports: field asc/desc. |
| [color] | <code>String</code> | color for table. |


* * *

&copy; 2020-2022 Pablo Schaffner &lt;pablo@puntorigen.com&gt;.

---
_Source: https://npm.io/package/@concepto/console · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._