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

@perfio/web-vitals

v1.0.10

Published

[Perfio](https://perfio.dev) is a service for collecting and analyzing performance metrics. The `@perfio/web-vitals` library helps gather these metrics effectively. This README provides instructions on how to use the library in different environments, suc

Downloads

65

Readme

@perfio/web-vitals

Perfio is a service for collecting and analyzing performance metrics. The @perfio/web-vitals library helps gather these metrics effectively. This README provides instructions on how to use the library in different environments, such as Next.js and browser environments.

Perfio Logo

Installation

You can install the @perfio/web-vitals library using npm or yarn:

npm install @perfio/web-vitals

or

yarn add @perfio/web-vitals

Usage

Next.js Integration

For integrating with Next.js, you can use the entry point @perfio/web-vitals/next. This entry point is designed to work seamlessly with the Next.js framework.

Setup

  1. Import the Provider: In your Next.js application, import the PerfioProvider from @perfio/web-vitals/next.

    import { PerfioProvider } from '@perfio/web-vitals/next';
  2. Add to Your Application.

    import { PerfioProvider } from '@perfio/web-vitals/next';
    
    import '../styles/globals.css';
    
    function RootLayout({ children }) {
      return (
        <html lang="en">
          <body>
            {children}
            {process.env.NEXT_PUBLIC_PERFIO_TOKEN && (
              <PerfioProvider token={process.env.NEXT_PUBLIC_PERFIO_TOKEN} />
            )}
          </body>
        </html>
      );
    }
    
    export default RootLayout;

This setup ensures that performance metrics are collected and sent to Perfio for analysis.

Browser Integration

For usage in a browser environment, you have two options: importing the library via a script with type module or using the default index entry point.

Import via Script

  1. Include Script Tag: Add the following script tag to your HTML file to load the library.

    <script
      type="module"
      src="https://cdn.jsdelivr.net/npm/@perfio/web-vitals@1/browser.esm.js?token=1234567890"
    ></script>

This approach allows you to load the library directly in the browser and start collecting. Replace 1234567890 with your Perfio token.

Default Import

  1. Import the Library: In your JavaScript file, import the reportMetrics function.

    import { reportMetrics } from '@perfio/web-vitals';
  2. Call the Function: Simply call the reportMetrics function to start collecting performance metrics.

    reportMetrics({
      token: '123456789',
    });

This setup is suitable for most standard web projects where you want to collect and report performance metrics to Perfio.