@sushensanthush/vibe-check

**A high-performance, zero-dependency network latency monitor for modern web apps.**

Explore Docs · Report Bug · Request Feature

---

Built With

## Features

• Real-time Monitoring: Tracks round-trip time (latency) in milliseconds accurately.
• Smart Status Categorization:
  • 🟢 excellent: Fast and reliable connection.
  • 🟡 stuttering: High latency or jitter is perfect for triggering "Slow Connection" UI warnings.
  • 🔴 offline: No connection detected or server unreachable.
• Zero Dependencies: Keeps your production bundle size ultra-small.
• Modern Stack: Fully typed with TypeScript for the best developer experience.

Installation

npm install @sushensanthush/vibe-check

Usage

import { VibeCheck } from '@sushensanthush/vibe-check';

const checker = new VibeCheck();
checker.start((vibe) => {
  console.log(vibe.status); // 'excellent', 'stuttering', or 'offline'
});

2. Publish to NPM

This is the big moment. Open your terminal in the vibe-check folder (not the test folder) and run:

1. Build one last time:

   npm run build

2. Log in to your account:

   npm login

   (It will open a browser window for you to sign in to npmjs.com)
3. Ship it:

   npm publish --access public

---

3. Clean Up Your Workspace

Once it is published, you don't need the local "links" anymore. You can clean up your machine:

# In vibe-test
npm unlink @sushensanthush/vibe-check
cd ..
rm -r vibe-test

# In vibe-check
npm unlink

📄 License

This project is licensed under the MIT License.

The MIT License is a permissive license that is short and to the point. It lets people do anything they want with your code as long as they provide attribution back to you and don’t hold you liable.

See the LICENSE file for the full text.