# @elixxrades/marc

> **MARC Readme.md**

Latest version **1.0.0** (published 2022-08-27) · 0 weekly downloads

## Install

```sh
npm install @elixxrades/marc
pnpm add @elixxrades/marc
yarn add @elixxrades/marc
bun add @elixxrades/marc
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-08-27 |
| First published | 2022-08-27 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 27.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | elixxrades |

## Links

- npm: https://www.npmjs.com/package/@elixxrades/marc
- npm.io page: https://npm.io/package/@elixxrades/marc

## Dependencies (5)

- [fs](https://npm.io/package/fs.md) ^0.0.1-security
- [chalk](https://npm.io/package/chalk.md) ^5.0.1
- [express](https://npm.io/package/express.md) ^4.18.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.1.0
- [@types/express](https://npm.io/package/@types/express.md) ^4.17.13

## Recent versions

- 1.0.0 (latest) — 2022-08-27

## README

**MARC Readme.md**

* Marc is a functional logger.

* Checkout test.js or test.ts

* Example Code: 
* * Typescript
```ts
import chalk from "chalk";
import MARC, { IOptions, ITypes } from "./marc.js";
import Express from "express"

const app = Express()
const marc = new MARC({
  name: "MARC",                                     //* Logger Name
  cleanUp: true,                                    //* Removes all log files then creates new ones instead. dont use with code folder all removes.
  types: [{
    name: "TEST",                                   //* Type Name Used at line:36
    hexColor: chalk.bgBlueBright,                   //* Type Color 
    textSequence: "\\/%N - %TP\\/ > \"%T\" > %D",   /**
     *? Text sequence.
     * %TP Debug Type [Required]
     * %N  Logger Name
     * %T  Time
     * %D  Data Text [Required]
     *
     * %PD Process ID (PID)
     * %PP Process Platform
     * %PA Process Arch
     * %NV Node Version
     * %PU Process User
   */
    textColor: chalk.bgRed                          //* Type Text Color
  } as ITypes],
  logDir: process.cwd() + "/logs/",                 //* Select Log directory
  object2string: true,                              //* Converts objects to string 
  useDefaultTypes: true                             //* Use default types [INFO, DEBUG, ERROR]
} as IOptions);

var testData = {
  m: "a",
  r: "c",
  e: "l",
  i: "x"
};

var testFunc = function () {
  console.log("testfcrunned");
};

(async () => {
  try {
    await marc.start();
    await marc.log("INFO", "info test", testFunc);
    await marc.log("DEBUG", "debug test", testData, testFunc);
    await marc.log("TEST", "ooOOOOOOoo")
  } catch (e) {
    console.log(e)
  }
})();

app.use(marc.express())
app.get("/", (req: Express.Request, res: Express.Response) => {
  res.send("essa")
})

app.listen(3000)
```

* * Javacript

```js
const MARC = require("./build/marc.js");
const chalk = require("chalk");

const express = require("express");
const app = express();

const marc = new MARC({
  name: "MARC", //* Logger Name
  cleanUp: true, //* Removes all log files then creates new ones instead. dont use with code folder all removes.
  types: [
    {
      name: "TEST", //* Type Name Used at line:36
      hexColor: chalk.bgBlueBright, //* Type Color
      textSequence: '\\/%N - %TP\\/ > "%T" > %D',
      /**
       *? Text sequence.
       * %TP Debug Type [Required]
       * %N  Logger Name
       * %T  Time
       * %D  Data Text [Required]
       *
       * %PD Process ID (PID)
       * %PP Process Platform
       * %PA Process Arch
       * %NV Node Version
       * %PU Process User
       */ textColor: chalk.bgRed, //* Type Text Color
    },
  ],
  logDir: process.cwd() + "/logs/", //* Select Log directory
  object2string: true, //* Converts objects to string
  useDefaultTypes: true,
});

marc.start();

marc.log("TEST", "Node Version", process.version);
marc.log("INFO", "Arch", process.arch);
marc.log("DEBUG", "Cpu Usage", process.cpuUsage());
marc.log("ERROR", "Little Error", process.ppid);

app.use(marc.express());
app.get("/", (req, res) => {
  res.send("essa");
});

app.listen(3000);

```

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