Skip to content

Latest commit

 

History

History
235 lines (171 loc) · 7.12 KB

README.md

File metadata and controls

235 lines (171 loc) · 7.12 KB
Raw

Fast File Converter

The Express.js's Fast File Converter Library

download-image

Ali-A-Koye - fast-file License

Fast File Converter Library is a quick and easy-to-use library to convert data sources to a variety of options. Fast File tries to make the developer's life easier by simplifying many conversion options (PDF, JSON, CSV, imSQL, text, excel, and Docx) with a single data source format.

Making the developer's life easier

Our idea for this package is to provide the basic needs of a developer when dealing with files simply.
When you only have a result of a query ( Array of Objects ) and you want to convert it to a form that a non-programmer can read and understand more easily, that's how our package helps you to convert your data into a variety of data representation forms just by calling one function.
 

Key Features

  • Easy to use.
  • Sending the response back to the client and completes the request-response cycle by itself
  • Files that have been generated will be sent back to the client as a stream, ensuring that a large amount of data can be transferred easily.
  • Option to rename the Headers for the data representation in table form.
  • Supports  PDF, JSON, CSV, imSQL, text, excel, and Docx.
  • Package built with Typescript, you will get the Typescript benefits of validation of your data if you already use Typescript. 

Table of Contents

Demo

This is a simple Demo environment for the package where you can use and test the package , clone it and it's simple express.js with TS application that is integrated with this package.

Work with the Demo instruction :

npm install  // Installing dependencies
npm run build  // To build the TS into JS code
npm run start // To start the express.js server

Requirements

In order to work with this package, you are required to :

  • install node.js and npm
  • install expres.js as your project must be express.js

Installation

To use the package you must first add the it to your dependencies in your project.

$ npm i fast-file-converter

Then you have to register the package in your project.

Typescript

import fastFile from "fast-file-converter";

Javascript

const fastFile = require("fast-file-converter").default;

Usage

With our aim for simplicity of this package, the integration part is the easiest and we will demonstrate it below.
 

PDF 

You can convert your array of an object into a nice, pre-styled table and have it downloaded right away, as simple as this : 

app.get("/pdf", (req, res) => {
  let data = [
    { name: "Ali", age: 23},
    { name: "Alison", age: 20 },
  ];
  fastFile(data, "pdf", res); //This will end the request as well.
});

DocX

You can convert your array of an object into a pre-configured table and have it downloaded right away, the benefit of this is that you can style it the way you want after downloading the docx.

app.get("/docx", (req, res) => {
  let data = [
    { name: "Ali", age: 23},
    { name: "Alison", age: 20 },
  ];
  fastFile(data, "docx", res);  //This will end the request as well.
});

Excel / XLSX

You can convert your array of an object into a nice, pre-styled Excel file and have it downloaded right away, as simple as this : 
 

app.get("/excel", (req, res) => {
  let data = [
    { name: "Ali", age: 23},
    { name: "Alison", age: 20 },
  ];
  fastFile(data, "excel", res); //This will end the request as well.
});

CSV

You can convert your array of an object into a CSV file and have it downloaded right away, as simple as this : 
 

app.get("/csv", (req, res) => {
  let data = [
    { name: "Ali", age: 23},
    { name: "Alison", age: 20 }, 
  ];
  fastFile(data, "csv", res); //This will end the request as well.
});

Text 

You can convert your array of an object into a readable .txt file and have it downloaded right away, as simple as this : 

app.get("/txt", (req, res) => {
  let data = [
      { name: "Ali", age: 23},
      { name: "Alison", age: 20 }, 
  ];
  fastFile(data, "txt", res); //This will end the request as well.
});

imSql ( insert Many SQL ) 

You can convert your array of an object into an insert many format of SQL file and have it downloaded right away, as simple as this : 
 

app.get("/imSql", (req, res) => {
  let data = [
      { name: "Ali", age: 23},
      { name: "Alison", age: 20 }, 
  ];
  fastFile(data, "imSql", res); //This will end the request as well.
});

JSON

You can convert your array of an object into an JSON format and have it downloaded right away, as simple as this : 

app.get("/json", (req, res) => {
  let data = [
      { name: "Ali", age: 23},
      { name: "Alison", age: 20 }, 
  ];
  fastFile(data, "json", res); //This will end the request as well.
});

AsOp (As Operation) Configuration :

AsOp is an array of objects, for which columns you want to have which field in your data, and which header for it. that means you can easily control the flow of your data by specifying a friendly name as a header and specifying the corresponding field with it.
 

app.get("/pdf", (req, res) => {
  let data = [
    { name: "Ali", age: 23},
    { name: "Alison", age: 20 },
  ];
  
 let asOp = [
   {
       field:"name" //field which points to a field in data array of object
       as:"Full Name of Employees"  //as is column header
   }
 ];
 
  fastFile(data, "pdf", res , asOp); //This will end the request as well.
});

With above example, you will get a table which has "Full Name of Employee" as header and the whole column is filled with names
 

API

Below is a table of acceptable parameters for this library.

Parameter Description Default Validations
data Array of Objects   Required
Type must be valid Enum ("pdf" , "excel" , "docx" , "csv" , "txt" ,"imSql" , “json” )   Required
response Express.js's Response Object   Required
AsOp As Operation is an Array of Objects []  

Author

Ali Amjed

License

The MIT License