Skip to content

Latest commit

 

History

History
103 lines (75 loc) · 5.23 KB

README.md

File metadata and controls

103 lines (75 loc) · 5.23 KB

Repl-uptime

📥 Installation

Node.js v12.0.0 or newer is required.

npm install @igorkowalczyk/repl-uptime
yarn add @igorkowalczyk/repl-uptime
pnpm add @igorkowalczyk/repl-uptime

📦 Examples

No Config

/// ES6
import Server from "@igorkowalczyk/repl-uptime";
new Server();

/// CommonJS
const Server = require("@igorkowalczyk/repl-uptime");
new Server();

That's it! 🎉 Your repl is now ready to be pinged. You can use uptimerobot.com or hetrixtools.com to ping your repl.

With Config (Advanced)

/// ES6
import Server from "@igorkowalczyk/repl-uptime";
new Server({
 port: 8080,
 path: "/",
 message: "🤙 Don't let your repl go to sleep!",
 debug: true,
});

/// CommonJS
const Server = require("@igorkowalczyk/repl-uptime");

new Server({
 port: 8080,
 path: "/",
 message: "🤙 Don't let your repl go to sleep!",
 debug: true,
});

📚 Documentation

🔧 Properties

Option Type Default Description
port Number 8080 The port number on which the server will listen for incoming requests.
path String / The custom URL path to be used for handling incoming requests.
message String 200 OK! The custom response message that will be sent back to clients when the request is successfully handled. Can be HTML or plain text.
debug Boolean false If set to true, enables debugging mode, which may log additional information about the server's behavior.

📜 Functions

Function Description
constructor(options) Initializes the server with the provided options and starts listening on the specified port.
listen() Starts the server to listen for incoming requests on the specified port. Returns a promise that resolves when the server starts listening successfully. If an error occurs, the promise is rejected. The function is called automatically by the constructor.
stop() Stops the server and closes the underlying HTTP server instance. Returns a promise that resolves when the server is successfully closed. If an error occurs, the promise is rejected.

⁉️ Issues

If you come across any errors or have suggestions for improvements, please create a new issue here and describe it clearly.

📥 Pull Requests

When submitting a pull request, please follow these steps:

  • Clone this repository https://github.com/IgorKowalczyk/repl-uptime.git
  • Create a branch from main and give it a meaningful name (e.g. my-awesome-new-feature).
  • Open a pull request on GitHub and clearly describe the feature or fix you are proposing.

📋 License

This project is licensed under the MIT. See the LICENSE file for details

This package is an independent project and is not affiliated, endorsed, or associated with Replit in any way.