Dash4 log
pretty log for dash4
[](https://www.npmjs.com/package/@dash4/log)
[](http://opensource.org/licenses/MIT) [](http://commitizen.github.io/cz-cli/) [](https://github.com/prettier/prettier) 
The following documentation is just relevant for dash4 plugin development. For informations on how to use Dash4 please read this: [Dash4 documentation](https://github.com/smollweide/dash4/blob/master/README.md)
## Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [server-side](#server-side)
* [client-side](#client-side)
* [License](#license)
## Installation
```shell
npm i -D @dash4/log
```
## Usage
### server-side
```ts
import { log, info, success, error, warn, spinner } from '@dash4/log';
log('terminal', 'place text here');
info('readme', 'place text here');
success('npm-scripts', 'place text here');
error('dependencies', 'place text here');
warn('ui', 'place text here');
const spin = spinner('terminal', 'load config');
spin.start();
await wait(1000);
spin.type('warn');
spin.text('needs longer than usual');
await wait(1000);
spin.succeed('config loaded');
```
*types*
```ts
type TPackageName = 'server' | 'terminal-emulator' | 'cli' | string;
type TMessage = string | number | object | any[];
type TType = 'log' | 'info' | 'success' | 'error' | 'warn';
export const log = (packageName: TPackageName, message: TMessage) => void;
export const info = (packageName: TPackageName, message: TMessage) => void;
export const success = (packageName: TPackageName, message: TMessage) => void;
export const error = (packageName: TPackageName, message: TMessage) => void;
export const warn = (packageName: TPackageName, message: TMessage) => void;
export function spinner(packageName: TPackageName, message: TMessage, type?: TType): {
start(): void;
succeed(_message: string): void;
fail(_message: string): void;
warn(_message: string): void;
info(_message: string): void;
text(_message: string): void;
type(_message: string): void;
stop(): void;
stopAndPersist(): void;
clear: (): void;
isSpinning: boolean;
indent: number;
}
```
### client-side
```ts
import { log, info, success, error, warn } from '@dash4/log/build/browser';
log('terminal', 'place some text here');
info('readme', 'place some text here');
success('npm-scripts', 'place some text here');
error('dependencies', 'place some text here');
warn('ui', 'place some text here');
```
*types*
```ts
export type TPackageName = 'client' | 'react-xterm' | 'ui' | string;
export type TMessage = string | number | object | any[];
export const log = (packageName: TPackageName, message: TMessage, ...args: TMessage[]) => void;
export const info = (packageName: TPackageName, message: TMessage, ...args: TMessage[]) => void;
export const success = (packageName: TPackageName, message: TMessage, ...args: TMessage[]) => void;
export const error = (packageName: TPackageName, message: TMessage, ...args: TMessage[]) => void;
export const warn = (packageName: TPackageName, message: TMessage, ...args: TMessage[]) => void;
```
## License
The @dash4/log is [MIT licensed](./LICENSE)