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

handdeng-node-server

v1.2.0-beta.1

Published

`handdeng-node-server` is a lightweight HTTP server framework built on Node.js, designed to simplify the creation and management of API services. This framework provides flexible routing, permission verification, parameter validation, and error handling m

Downloads

414

Readme

handdeng-node-server

Introduction

handdeng-node-server is a lightweight HTTP server framework built on Node.js, designed to simplify the creation and management of API services. This framework provides flexible routing, permission verification, parameter validation, and error handling mechanisms, making it ideal for building high-performance RESTful API services.

Features

  • GET/POST Routing: Supports the registration of handler functions for GET and POST requests.
  • Permission Verification: Allows enabling or disabling permission checks for individual APIs.
  • Parameter Validation: Supports type and required field validation for API request parameters.
  • Global Error Handling: Provides customizable global error handling mechanisms.
  • Flexible Routing: Supports custom handling for missing routes and incorrect HTTP methods.

Quick Start

  1. Install Dependencies

    npm install handdeng-node-server
  2. Create a Server Instance

    import { NodeServer } from "handdeng-node-server";
    const server = new NodeServer(3000, "localhost");
  3. Register API Routes

    server.get("/api/test", (req, res) => {
      res.writeHead(200, { "Content-Type": "application/json" });
      res.end(JSON.stringify({ message: "GET request success" }));
    });
    
    server.post("/api/test", (req, res) => {
      res.writeHead(200, { "Content-Type": "application/json" });
      res.end(JSON.stringify({ message: "POST request success" }));
    });
  4. Start the Server

    Run your script to start the server:

    node index.js
  5. Test the API

    You can test your API by visiting http://localhost:3000/api/test.

API Configuration Options

  • openPermissionVerify: Whether to enable permission verification. Default is true.
  • paramsList: A list of parameter validation rules, including the parameter key, type, and whether it's required.

Error Handling

  • catch: Global error handler function.
  • paramsError: Handler function for request parameter errors.
  • notFount: Handler function for cases where the route is not found.
  • methodsError: Handler function for incorrect HTTP methods.