npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ts-syslog

v1.0.2

Published

Fully typed NodeJS Syslog Server

Downloads

29

Readme

TS-Syslog

npm GitHub Workflow Status npm bundle size Commitizen friendly semantic-release: angular

Fully typed NodeJS Syslog Server for ESM, CJS and Typescript.

Quick Start

Installation
$ npm install ts-syslog
Usage
import SyslogServer from "ts-syslog";
const server = new SyslogServer();

server.on("message", (value) => {
    console.log(value.date);     // the date/time the message was received
    console.log(value.message);  // the syslog message
});

server.on("error", (err: SyslogError) => {
    console.error(err.message)
})

server.listen({port:514}, () => {
    console.log("Syslog listening on port 514")
});

Functions

listen([options], [callback])

  • options [Object] - The options passed to the server. Supports the following properties:
    • port [Number] - The UDP port which will be used to listen.
    • address [String] - Optional - The address which will be used - Defaults to "0.0.0.0".
  • callback [Function] - Optional - Callback function called once the server starts.

Note

For more information on the options object, check NodeJS official API documentation.

close([callback])

  • callback [Function] - Optional - Callback function called once the server socket is closed.

isRunning()

The isRunning function is a synchronous function that returns a Boolean value indicating if the server is ready to receive syslog messages or not.

Note

  • Both the start and close functions return Promises.

Callbacks

Both the listening() and close() functions callbacks are expected to only have the optional parameter which can be or error or null as, for example:

// this is correct
server.close(() => {/** your code **/}) 

// this is also correct
server.close((err) => {/** your code **/})

Events

  • start - Fired once the server is ready to receive syslog messages.
  • stop - Fired once the server is shutdown.
  • error - Fired whenever an error occur, an error object is passed to the handler function.
  • message - Fired once the server receives a syslog message.

Types

  • SyslogOptions - Contains the type definition for the parameter options from the listen(options, callback) function
  • SyslogMessage - Type definition for the message sent on the message event
  • SyslogError - The type definition for the errors returned by the error event

You can check the examples at ./examples