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

febpop

v0.2.7

Published

[![Build Status](https://circleci.com/gh/justincase-jp/Febpop/tree/master.svg?style=shield)]( https://circleci.com/gh/justincase-jp/Febpop ) [![npm version](https://badge.fury.io/js/febpop.svg)]( https://badge.fury.io/js/febpop )

Downloads

9

Readme

Build Status npm version

Febpop

Febpop is an opinionated wrapper to enforce consistent data transmission within Socket.IO.

The reliability of packet transmission in Socket.IO is guaranteed by the underlying TCP protocol. Combining with its built-in acknowledgement mechanism, it would seem at first, transactional message deliveries can be implemented by simplify waiting for acknowledgement responses from the server.

However, in the real world, clients may have poor networks and servers need restarts from time to time. A client could get stuck in waiting for acknowledgement responses that will never happen.

This library is created to address such a problem by enforcing at-least-once delivery semantics:

  • Each emission of messages in this library is preconfigured with a timeout (default: 10 seconds).
  • Within the configured timeout, a re-emission will be attempted every time a reconnection takes place, until it is confirmed as acknowledged from the server.

Installation

npm install febpop

Usage

While Socket.IO is a rich library that provides quite an amount of features, this library focuses on an essential subset. The core interface is simplified as:

export interface Febpop {
  on<T>(event: string): (action: (argument: T) => void) => void

  emit<T>(event: string, timeout?: number): (argument: T, onTimeOut: () => void) => CompletionHandler
  emit<T>(event: string, timeout: null): (argument: T) => CompletionHandler
}

Functions are curried in advance for the ease to define message types. For example:

import febpop, { Febpop } from 'febpop'

class ApiService {
  constructor(private readonly febpop: Febpop = febpop('http://example.com/')) {
  }

  onConnect = this.febpop.on<unknown>('connect')
  onToggle = this.febpop.on<'on' | 'off'>('toggle')

  emitChat = this.febpop.emit<{ requestKey: number, text: string }>('chat')
  emitCount = this.febpop.emit<number>('count')
}

Important: You may want to ensure callbacks at the server-side, as such:

import { listen } from 'socket.io'

cosnt server = listen(80)

server.on(
  'connect',
  socket => {
    socket.on('event1', (event1, callback) => {
      // Perform server-side logics on `event1`
      // ...
      callback()
    })
  }
)

// Or even more carefully
server.on(
  'connect',
  socket => {
    socket.on('event2', (event2, callback) => {
      try {
        // Perform server-side logics on `event2`
        // ...
      } finally {
        callback()
      }
    })
    socket.on('event3', (event3, callback) => {
      const promise = new Promise(resolve => {
        // Perform server-side logics on `event3`
        // ...
        resolve()
      })
      promise.finally(callback)
    }
  }
)