Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/panosoft/js-xlsx-gen-server

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/panosoft/js-xlsx-gen-server
Owner: panosoft
Created: 2016-02-04T20:56:01.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2016-02-04T22:52:16.000Z (almost 9 years ago)
Last Synced: 2023-04-10T13:46:21.121Z (over 1 year ago)
Language: JavaScript
Size: 6.84 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# JS Xlsx Gen server

> An excel spreadsheet rendering server.

[![npm version](https://img.shields.io/npm/v/@panosoft/js-xlsx-gen-server.svg)](https://www.npmjs.com/package/@panosoft/js-xlsx-gen-server)
[![Travis](https://img.shields.io/travis/panosoft/js-xlsx-gen-server.svg)](https://travis-ci.org/panosoft/js-xlsx-gen-server)

# Installation

```sh
npm install -g @panosoft/js-xlsx-gen-server
```

# Usage

```sh
Usage: js-xlsx-gen-server --key --cert [options]

An excel spreadsheet rendering server.

Options:

-h, --help output usage information
-V, --version output the version number
-k, --key Path to the private key of the server in PEM format.
-c, --cert Path to the certificate key of the server in PEM format.
-p, --port The port to accept connections on. Default: 8443.
-i, --interface The interface to accept connections on. Default: 0.0.0.0.
```

# HTTPS API

## Request

- Path: `/`
- Method: `POST`
- Headers:
- `Content-Type` - `'application/json'`
- Body:
- `spreadsheet` - {Object} The spreadsheet definition used to create the excel spreadsheet.
- `[defaultStyle]` - {Object} The default style definition to apply to the spreadsheet.
- `[header]` - {Object} The header default style definition.
- `[data]` - {Object} The data default style definition.

## Responses

__Success__
- Status Code: `200`
- Headers:
- `Request-Id` - {String} The unique request identifier.
- `Content-Type` - `'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'`
- Body: {Buffer} The excel spreadsheet binary.

__Error__
- Status Code: `500`
- Headers:
- `Request-Id` - {String} The unique request identifier.
- `Content-Type` - `'application/json'`
- Body:
- `error` - {String} The error message.