Skip to content
This repository was archived by the owner on Mar 1, 2024. It is now read-only.

EDMdesigner/ping-routes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
Jul 26, 2021
Jul 26, 2021
Apr 14, 2015
Feb 21, 2020
Jul 27, 2021

Repository files navigation

ping-routes

Ping routes for node.js

Usage

var pingRoutes = require("ping-routes");

...

pingRoutes({ app: app, sysinfo: true, mongo: true, file: true, redis: { port: 1337, //your redis port url: "yourRedisUrl", pass: "yourRedisPass" } });

where app is an express application.

With the configuration above, the pingRoutes function will add the following routes to your app:

  • /ping
    • The response of this should be PONG. (with text/plain content type).
  • /ping/sysinfo
    • This route uses express-ping.
  • /ping/mongo
    • The response of this should be PONG. (with text/plain content type).
    • Queryies an empty collection in MongoDB through the default connection.
  • /ping/file
    • The response of this should be PONG. (with text/plain content type).
    • Writes 4 bites to a file, reads and deletes it.
  • /ping/redis
    • The response of this should be PONG. (with text/plain content type).
    • Queryies a non existing hash from redis.