# utililogs-client

> Client interface to send logs to UtiliLogs through a WebSocket

Latest version **1.0.3** (published 2019-10-09) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install utililogs-client
pnpm add utililogs-client
yarn add utililogs-client
bun add utililogs-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.3 |
| Published | 2019-10-09 |
| First published | 2019-10-09 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 1.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ZeLarpMaster |
| Maintainers | zelarpmaster |

## Links

- npm: https://www.npmjs.com/package/utililogs-client
- Repository: https://gitlab.com/utililogs/js-client
- Homepage: https://gitlab.com/utililogs/backend#readme
- Issues: https://gitlab.com/utililogs/backend/issues
- npm.io page: https://npm.io/package/utililogs-client

## Dependencies (1)

- [phoenix-channels](https://npm.io/package/phoenix-channels.md) ^1.0.0

## Recent versions

- 1.0.3 (latest) — 2019-10-09
- 1.0.2 — 2019-10-09
- 1.0.1 — 2019-10-09

## README

# UtiliLogs Client

A client library for interfacing with UtiliLogs - an external and real-time logging system

### Usage

```javascript
const createUtiliLogsClient = require("utililogs-client")

// host starts with `ws://` or `wss://` (ie.: ws://localhost:4000)
// token is given by UtiliLogs and is a string
const client = createUtiliLogsClient(host, token)

// emoji and id are optional
// message is required
// one of `timestamp_s` or `timestamp_ms` is required
client.log({
    emoji: "🎉",
    id: "123456789",
    message: "We logged in!",
    timestamp_ms: Date.now(),
})

// optional, but can be used for cleaner shutdowns
client.close()
```

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