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

metricsfn

v1.0.41

Published

Get metric data on your scripts

Downloads

3

Readme

Metricsfn

Introduction

metricsfn is a lightweight JavaScript library designed to facilitate the collection of metrics and performance data in an application.

Installation

Install the library via npm:

npm install metricsfn

Usage


// Create an instance of Metrics
const metrics = new Metrics();

// Initialize Metrics
metrics.Init();

// Add an ID
metrics.ID(123);

// Add data
metrics.UserID('user123')
    .TimeSamp()
    .ParseErrors();

// Retrieve data
const data = metrics.env();
console.log(data);

Example

const axios = require('axios')
const Metrics = require('metricsfn')
const metrics = new Metrics();

async function makeRequest(url, method = 'GET', data = null) {
  metrics.Init();
  const id = 123
  metrics.ID(id);
  metrics.ID(id).TimeSamp()

  const datas = {};
  const metricsDatas = {};

  try {
    metrics.TimerStart(id);
    const response = await axios({
      method,
      url,
      data,
    });

    metrics.ID(id).FetchTimeExec(metrics.TimerStop(id)).Success()
    datas = response.data
    metricsDatas = metrics.ID(id).env()

    return {datas, metricsDatas};

  } catch (error) {
    metrics.ID(id).FetchTimeExec(metrics.TimerStop(id)).FetchError().Aborted()
    metricsDatas = metrics.ID(id).env()

    return {datas, metricsDatas};

  }

}

const apiUrl = 'https://jsonplaceholder.typicode.com/posts/1';
makeRequest(apiUrl, 'GET');

Available Methods

Init()

Initializes the Metrics library.

ID(id: string)

Adds a new ID to the data table.

  • id: Unique identifier.

UserID(data: string)

Adds the user ID to the data.

  • data: User ID.

TimeSamp()

Adds a timestamp to the data.

ParseErrors()

Increments the parse errors count in the data.

SyntaxErrors()

Increments the syntax errors count in the data.

FilterTimeExec(timesamp: string)

Adds filter execution time to the data.

  • timesamp: Timestamp of filter execution time.

GenerateTimeExec(timesamp: string)

Adds generation execution time to the data.

  • timesamp: Timestamp of generation execution time.

FetchTimeExec(timesamp: string)

Adds fetch execution time to the data.

  • timesamp: Timestamp of fetch execution time.

Aborted()

Indicates in the data that the operation was aborted.

Exited()

Indicates in the data that the operation was exited.

Success()

Indicates in the data that the operation was successful.

TimerStart(key: string)

Starts a timer with the specified key.

  • key: Timer key.

TimerStop(key: string)

Stops the timer and returns the elapsed time.

  • key: Timer key.

TimerClear(key: string)

Stops and clears the timer associated with the specified key.

  • key: Timer key.

env()

Gets the complete data array.