docs.sheetjs.com/docz/docs/03-demos/30-cloud/19-deno.md
SheetJS 92e3c5aa72 mdx cleanup in preparation for v2
- use autolinks (e.g <https://sheetjs.com> -> https://sheetjs.com)
- move <summary> blocks to separate lines
2024-04-08 00:57:39 -04:00

4.0 KiB

title pagination_prev pagination_next
Deno Deploy demos/local/index demos/extensions/index

import current from '/version.js'; import CodeBlock from '@theme/CodeBlock';

Deno Deploy offers distributed "Serverless Functions" powered by Deno.

SheetJS is a JavaScript library for reading and writing data from spreadsheets.

This demo covers integration details. We'll explore how to load and use SheetJS scripts in Deno Deploy functions.

The "Demo" section builds a sample service that converts XLSX and other types of spreadsheets to HTML tables and CSV rows.

:::caution pass

When the demo was last tested, Deno Deploy required a GitHub account.

:::

:::note Tested Deployments

This demo was last tested by SheetJS users on 2023 October 18.

:::

Integration Details

The SheetJS Deno module can be imported from Deno Deploy server scripts.

Supported Frameworks

:::warning pass

Deno Deploy does not offer any sort of temporary file access in functions.

This breaks web frameworks that use the filesystem in body parsing.

:::

When the demo was last tested, the drash server framework used an in-memory approach for parsing POST request bodies.

The Drash demo covers the framework in detail.

Parsing Data

When files are submitted via HTTP POST, the bodyParam method can fetch data. The content property of the returned object can be parsed with XLSX.read.

The following example assumes the file is submitted at field name file:

{\ // @deno-types="https://cdn.sheetjs.com/xlsx-${current}/package/types/index.d.ts" import { read, utils } from 'https://cdn.sheetjs.com/xlsx-${current}/package/xlsx.mjs'; import * as Drash from "https://cdn.jsdelivr.net/gh/drashland/drash@v2.8.1/mod.ts"; \n\ class SheetJSResource extends Drash.Resource { public paths = ["/"]; \n\ public POST(request: Drash.Request, response: Drash.Response) { // highlight-start /* get data from body */ const file = request.bodyParam<Drash.Types.BodyFile>("file"); /* parse */ var wb = read(file.content, {type: "buffer", dense: true}); // highlight-end /* generate HTML from first worksheet */ return response.html(utils.sheet_to_html(wb.Sheets[wb.SheetNames[0]])); } }}

Demo

  1. Create a new GitHub account or sign into an existing account.

  2. Open the main Deno Deploy portal in a browser.

  3. If the account never signed into Deno Deploy, click "Continue with Github".

In the next screen, review the prompt and click "Authorize Deno Deploy"

  1. Click "New Playground" to create a new Playground.

  2. Download s2c.ts.

  3. Open s2c.ts with a text editor and copy the contents of the source file into the playground editor (left pane in the browser).

  4. Click "Save and Deploy". When the demo was last tested, it was a blue button.

Testing

  1. Wait until the server is deployed. When it is deployed, the right panel will show "SheetJS Spreadsheet Conversion Service":

Screenshot

  1. Download the test file https://sheetjs.com/pres.xlsx

  2. In the browser window, click "Choose File" and select the downloaded file.

  3. Click "Submit". The right panel will show the contents in a HTML TABLE.

  4. Open a terminal window and download https://sheetjs.com/pres.numbers:

curl -LO https://sheetjs.com/pres.numbers
  1. Copy the first curl line from the page and run in the terminal. For example, if the deployment is clean-badger-69, the command would be
curl -X POST -F"file=@pres.numbers" https://clean-badger-69.deno.dev/

The output will be an HTML table

  1. Copy the second curl line from the page and run in the terminal. For example, if the deployment is clean-badger-69, the command would be
curl -X POST -F"file=@pres.numbers" -F"type=csv" https://clean-badger-69.deno.dev/

The output will be CSV.