# @sorg/log

> > Note: this package has been renamed to [suf-log](https://www.npmjs.com/package/suf-log) and is therefore deprecated.

Latest version **2.2.1** (published 2020-11-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @sorg/log
pnpm add @sorg/log
yarn add @sorg/log
bun add @sorg/log
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.2.1 |
| Published | 2020-11-05 |
| First published | 2019-11-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 21 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Syler |
| Maintainers | the_real_syler |
| Keywords | logger |

## Links

- npm: https://www.npmjs.com/package/@sorg/log
- Repository: https://github.com/TheRealSyler/s.log
- Homepage: https://github.com/TheRealSyler/s.log#readme
- Issues: https://github.com/TheRealSyler/s.log/issues
- npm.io page: https://npm.io/package/@sorg/log

## Dependencies (1)

- [s.color](https://npm.io/package/s.color.md) 0.0.15

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 2.2.1 (latest) — 2020-11-05
- 2.2.0 — 2020-08-23
- 2.1.0 — 2020-03-13
- 2.0.1 — 2020-02-02
- 2.0.0 — 2020-02-02
- 1.1.0 — 2020-01-29
- 1.0.3 — 2019-12-08
- 1.0.2 — 2019-11-23
- 1.0.0 — 2019-11-12

## README

## @sorg/log

> Note: this package has been renamed to [suf-log](https://www.npmjs.com/package/suf-log) and is therefore deprecated.

<span id="BADGE_GENERATION_MARKER_0"></span>
[![circleci](https://img.shields.io/circleci/build/github/TheRealSyler/s.log)](https://app.circleci.com/github/TheRealSyler/s.log/pipelines) [![Custom](https://codecov.io/gh/TheRealSyler/s.log/branch/master/graph/badge.svg)](https://codecov.io/gh/TheRealSyler/s.log) [![npmV](https://img.shields.io/npm/v/@sorg/log?color=green)](https://www.npmjs.com/package/@sorg/log) [![min](https://img.shields.io/bundlephobia/min/@sorg/log)](https://bundlephobia.com/result?p=@sorg/log) [![install](https://badgen.net/packagephobia/install/@sorg/log)](https://packagephobia.now.sh/result?p=@sorg/log) [![githubLastCommit](https://img.shields.io/github/last-commit/TheRealSyler/s.log)](https://github.com/TheRealSyler/s.log)
<span id="BADGE_GENERATION_MARKER_1"></span>

<span id="DOC_GENERATION_MARKER_0"></span>

# Docs

- **[interfaces](#interfaces)**

  - [LogStyle](#logstyle)
  - [ConverterInput](#converterinput)
  - [LogMessage](#logmessage)
  - [LogTable](#logtable)

- **[loggers](#loggers)**

  - [Log](#log)
  - [LogTableOptions](#logtableoptions)
  - [LogTable](#logtable)

- **[styler](#styler)**

  - [styler](#styler)

### interfaces

##### LogStyle

```typescript
/**
 * color/background/font-weight work in node and the browser, the other properties only work in the browser.
 */
type LogStyle = string | {
    background?: string;
    color?: string;
    padding?: string;
    margin?: string;
    border?: string;
    /** for bold text in node add the value 'bold' */
    'font-weight'?: FontWeightProperty;
    /** if true the style doesn't get reset in node. */
    [key: string]: number | boolean | string | undefined;
}
```

##### ConverterInput

```typescript
type ConverterInput = AcceptableTypes | Array<AcceptableTypes>;
```

##### LogMessage

```typescript
type LogMessage = {
    message: string;
    style?: LogStyle;
}
```

##### LogTable

```typescript
type LogTable = (number | string | LogMessage)[][];
```

### loggers

##### Log

```typescript
function Log(...messages: (string | LogMessage)[]): void;
```

##### LogTableOptions

```typescript
interface LogTableOptions {
    padding?: number;
    spacing?: number;
}
```

##### LogTable

```typescript
/**Logs a table in node. */
function LogTable(table: LogTable, options?: LogTableOptions): void;
```

### styler

##### styler

```typescript
function styler(input: string, style?: LogStyle): string;
```

_Generated with_ **[suf-cli](https://www.npmjs.com/package/suf-cli)**
<span id="DOC_GENERATION_MARKER_1"></span>

### License

<span id="LICENSE_GENERATION_MARKER_0"></span>
Copyright (c) 2020 Leonard Grosoli Licensed under the MIT license.
<span id="LICENSE_GENERATION_MARKER_1"></span>

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