konbert-api

Konbert - File Conversion API Wrapper

Konbert API is a Node.js wrapper for the Konbert.com File Conversion API. It provides a convenient way to convert files between different formats such as JSON, CSV, Avro, and Excel. This wrapper simplifies the process of making API requests and handling file conversions.

Installation

To use Konbert, you need to have Node.js installed. You can then install the package using npm:

npm install konbert-api

Usage

Here's an example of how to use Konbert to convert files:

import Konbert from "konbert-api";

// Example Usage
const apiKey = "YOUR_API_KEY";
const konbert = new Konbert({ apiKey });

const data = JSON.stringify([
  {
    name: "John Doe",
    age: 30,
    city: "New York",
  },
  {
    name: "Jane Doe",
    age: 25,
    city: "San Francisco",
  },
]);

try {
  const result = await konbert.convert(data, "json", "csv");

  console.log("Conversion successful:", result.toString());
} catch (error) {
  console.log("Conversion failed. Error:", error);
}

Make sure to replace 'YOUR_API_KEY' with your actual API key.

The convert method accepts the following parameters:

• data: The input data to be converted. It can be a string, Buffer, Blob, or an HTTPInput object containing the URL and headers.
• input: The input format. It can be one of the following: 'csv', 'json', 'avro', or 'excel'. You can also provide additional options specific to the input format.
• output: The output format. It can be one of the following: 'csv', 'json', 'avro', or 'excel'. You can also provide additional options specific to the output format.

The convert method returns a Promise that resolves to a Blob containing the converted file data.

For more details about the available options and formats, refer to the Konbert API documentation.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please create a new issue or submit a pull request.

License

This project is licensed under the MIT License.