# @types/glossy

> TypeScript definitions for glossy

Latest version **0.1.3** (published 2023-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/glossy
pnpm add @types/glossy
yarn add @types/glossy
bun add @types/glossy
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2023-11-22 |
| First published | 2021-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/glossy
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/glossy
- npm.io page: https://npm.io/package/@types/glossy

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 0.1.3 (latest) — 2023-11-22
- 0.1.0 (ts3.7) — 2021-10-26
- 0.1.2 — 2023-11-07
- 0.1.1 — 2023-10-18

## README

# Installation
> `npm install --save @types/glossy`

# Summary
This package contains type definitions for glossy (https://github.com/squeeks/glossy).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/glossy.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/glossy/index.d.ts)
````ts
/// <reference types="node" />

export interface ProduceOptions {
    facility?: string;
    severity?: string;
    host?: string;
    appName?: string;
    pid?: string | number;
    msgID?: string;
    type?: string;
}

export interface MessageOptions {
    facility?: string;
    severity?: string;
    prival?: number;
    host?: string;
    appName?: string;
    pid?: string | number;
    date?: Date;
    time?: Date;
    msgID?: string;
    structuredData?: unknown;
    message?: string;
}

export interface ProducerCallback {
    (compiledMessage: string): void;
}

export class Produce {
    constructor(options: ProduceOptions | string);

    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
    alert(options: MessageOptions, callback?: ProducerCallback): string | void;

    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
    crit(options: MessageOptions, callback?: ProducerCallback): string | void;

    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
    debug(options: MessageOptions, callback?: ProducerCallback): string | void;

    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
    emergency(options: MessageOptions, callback?: ProducerCallback): string | void;

    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
    info(options: MessageOptions, callback?: ProducerCallback): string | void;

    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
    notice(options: MessageOptions, callback?: ProducerCallback): string | void;

    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
    produce(options: MessageOptions, callback?: ProducerCallback): string | void;

    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
    warn(options: MessageOptions, callback?: ProducerCallback): string | void;
}

export interface ParserCallback {
    (parsedMessage: SyslogMessage): void;
}

export interface SyslogMessage {
    originalMessage: string;
    type: string;
    time: Date;
    message: string;
    host?: string | null;
    appName?: string | null;
    pid?: string | null;
    msgID?: string | null;
    structuredData?: unknown;
}

export namespace Parse {
    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
    function parse(rawMessage: string | Buffer, callback?: ParserCallback): SyslogMessage | void;
}

````

### Additional Details
 * Last updated: Wed, 22 Nov 2023 00:24:48 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [bmaupin](https://github.com/bmaupin).

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