CronyxClient.js
API | Code of Conduct | Contributing | Changelog
A TypeScript HTTP client wrapper for CronyxServer, seamlessly integrating the power of Cronyx across platforms using a familiar API interface.
🌟 Features
CronyxClient.js bridges the capabilities of Cronyx and CronyxServer, offering a way to schedule and manage tasks without losing the feel of the original Cronyx API.
Why CronyxClient.js?
🌐 Unified Experience: Retain the simplicity and power of the Cronyx API while benefiting from the language-agnostic capabilities of CronyxServer.
🔌 Plug & Play: With just a URL configuration, connect to any running instance of CronyxServer and harness its capabilities without changing your existing Cronyx codebase.
🚀 Familiar API: Use the same API as Cronyx, and let CronyxClient.js handle the translation to CronyxServer's RESTful API.
🚀 Getting Started
To harness the capabilities of CronyxClient.js, follow these simple steps:
Installation
Install the CronyxClient.js package using npm:
$ npm install cronyx-client
# or
# $ bun add cronyx-client
Basic Usage
Using CronyxClient.js mirrors the use of Cronyx, with the additional specification of the CronyxServer URL:
import CronyxClient from "cronyx-client";
const cronyx = new CronyxClient({ url: "http://localhost:3000/" });
const job = await cronyx.requestJobStart({
jobName: "hourly-job",
jobInterval: "0 * * * *",
});
// The rest of your code remains the same
Integrations and Compatibilities
CronyxClient.js is built on top of the Cronyx foundation, ensuring compatibility and integration with:
- Cronyx: Maintain the same API functions and structures, ensuring a seamless transition to CronyxClient.js.
- CronyxServer: Directly communicates with the server using its RESTful endpoints, translating your Cronyx API calls to HTTP requests.
💻 Development
Using Visual Studio Code and the Dev Containers extension, you can simplify the development environment setup process. The extension allows you to develop inside a Docker container and automatically sets up the development environment for you.
-
Install the Dev Containers extension in Visual Studio Code.
-
Clone the repository:
git clone https://github.com/yujiosaka/CronyxClient.js.git
-
Open the cloned repository in Visual Studio Code.
-
When prompted by Visual Studio Code, click "Reopen in Container" to open the project inside the Docker container.
-
The extension will build the Docker container and set up the development environment for you. This may take a few minutes.
-
Build and run the Docker container with Docker Compose:
$ docker-compose up --build
This will start testing in watch mode.
🧑💻️ API reference
See here for the API reference.
🐞 Debugging tips
Enable debug logging
Job status changes are logged via the debug module under the cronyx:client
namespace.
env DEBUG="cronyx:client" node script.js
# or
# env DEBUG="cronyx:client" bun script.js
💳 License
This project is licensed under the MIT License. See LICENSE for details.