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

build-my-meta

v1.1.0

Published

A flexible and powerful package for logging metadata from API calls, compatible with multiple databases (MongoDB, PostgreSQL, MySQL, etc.).

Downloads

121

Readme

Build-My-Meta (Metadata-Logger)

Build-My-Meta is a powerful and flexible metadata logging package for API calls, designed to support multiple databases. This package automatically logs metadata related to API requests and responses, making it easy to monitor user actions, performance, and errors.

🦒 Supported Databases

  1. MongoDB
  2. PostgreSQL
  3. MySQL
  4. Firebase Realtime Database / Firestore
  5. SQLite
  6. Cassandra
  7. Neo4j
  8. MariaDB
  9. Redis (Coming soon)
  10. Oracle Database (Coming soon)

🦓 Supported Frameworks & Environments

  1. Node.js
  2. Express.js
  3. Next.js (Manual Edition Only)
  4. Fastify (Coming Soon)

🐒 Installation

Install the package using npm:

npm install build-my-meta

🐸 Getting Started

Basic Setup

In your main server file (e.g., app.js), import and configure the BuildMyMeta middleware. Based on the database type, pass your initialized database instance to the BuildMyMeta middleware.


🐺 Documentation on Website:

Below are some examples of how to configure and use the packages, but they might not be available latest, or might not have detailed step by step process to understand the uses. Visit our website documentation for better understanding.

Website Documentation Link: https://.../build-my-meta

~🦈 Backend (Database-Specific Setup Examples)

1. MongoDB ~ 🌿Weblink {#mongodb}

2. PostgreSQL ~ 🌿Weblink {#postgresql}

3. MySQL ~ 🌿Weblink {#mysql}

4. Firebase Realtime Database / Firestore ~ 🌿Weblink {#firebase}

5. SQLite ~ 🌿Weblink {#sqlite}

6. Cassandra ~ 🌿Weblink {#cassandra}

7. Neo4j ~ 🌿Weblink {#neo4j}

8. MariaDB ~ 🌿Weblink {#mariadb}

~ 🐳 Frontend (Next.js) ~ 🌿Weblink

In Next.js, you can use BuildMyMeta middleware within custom API routes under pages/api. This allows you to set up automatic or manual metadata logging as needed.

Notes for Next.js

  • Environment Variables: Store sensitive information in .env files and avoid exposing them to the client side.
  • Database Connection: Ensure your database connection is established before logging, as shown in the examples above.

~ 🪸 Error Handling and Logs

Error logs are stored in the metaError.json file if any issues occur during metadata logging.


~ 🐦‍🔥 Troubleshooting

  • Missing Database Instance: Ensure to pass an initialized instance (e.g., mongoose for MongoDB).
  • Unsupported Database: Verify that the database type is supported.

License

This package is licensed under the MIT License.