# x-log-client

> The task of this library is to facilitate the use of the X-Log api with node js. The API key and further information can be found at [log.x46.me](https://log.x46.me). ## Quickstart ### 1. Install ```bash npm install x-log-client ``` ### 2. run ```javascr

Latest version **1.0.5** (published 2022-01-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install x-log-client
pnpm add x-log-client
yarn add x-log-client
bun add x-log-client
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2022-01-29 |
| First published | 2022-01-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | x46 |
| Maintainers | x46 |
| Keywords | log, x-log |

## Links

- npm: https://www.npmjs.com/package/x-log-client
- Homepage: http://log.x46.me
- npm.io page: https://npm.io/package/x-log-client

## Dependencies (1)

- [request](https://npm.io/package/request.md) 2.88.2

## 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

- 1.0.5 (latest) — 2022-01-29
- 1.0.4 — 2022-01-29
- 1.0.3 — 2022-01-29
- 1.0.2 — 2022-01-29
- 1.0.1 — 2022-01-29
- 1.0.0 — 2022-01-28

## README

# X-Log
The task of this library is to facilitate the use of the X-Log api with node js. 
The API key and further information can be found at [log.x46.me](https://log.x46.me).
## Quickstart
### 1. Install
```bash
npm install x-log-client
```
### 2. run
```javascript
const xlog = require('x-log-client');
var logger = new xlog("api key", "project id");

logger.log("Start");

logger.log("Error", 2, "An error has occurred");

```
<br>

## API

```javascript
new xlog(string, string, boolean);
```
|  | | |
| :---:   | :-: | - |
| 1 | string | your api key |
| 2 | string | the public project id |
| 3 | boolean | use https for request (optional) |

<br>

```javascript
.log(string, number, string);
```


|  | | |
| :---:   | :-: | - |
| 1 | string | main text to log |
| 2 | number | types of messages, the default is 0  (optional) |
| 3 | string | an additional text (optional) |

<br>

## Types of messages

| type | meaning  | 
| :---:   | - |
| 0 | default message | 
| 1 | warning message | 
| 2 | Error message |

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