LankyMoose/docs.sheetjs.com
1
Fork 0
forked from sheetjs/docs.sheetjs.com
Code Pull Requests Activity
e273f11b46
docs.sheetjs.com/docz/docs/03-demos/03-net/01-network/index.mdx

620 lines
16 KiB
Plaintext
Raw Normal View History

network
2022-08-05 05:10:11 +00:00
---
upload
2023-11-20 02:51:39 +00:00
title: HTTP Downloads
pagination_next: demos/net/upload/index
network
2022-08-05 05:10:11 +00:00
---
<head>
netsuite-amd
2024-01-17 20:22:38 +00:00
<script src="https://unpkg.com/axios@1.6.5/dist/axios.min.js"></script>
<script src="https://unpkg.com/superagent@8.1.2/dist/superagent.min.js"></script>
network
2022-08-05 05:10:11 +00:00
</head>
ns-http
2023-05-21 07:03:46 +00:00
import current from '/version.js';
import CodeBlock from '@theme/CodeBlock';
content
2022-08-13 22:01:26 +00:00
math
2024-01-03 06:47:00 +00:00
`XMLHttpRequest` and `fetch` browser APIs enable binary data transfer between
web browser clients and web servers. Since this library works in web browsers,
server conversion work can be offloaded to the client! This demo shows a few
common scenarios involving browser APIs and popular wrapper libraries.
upload
2023-11-20 02:51:39 +00:00
:::info pass
This demo focuses on downloading files. Other demos cover other HTTP use cases:
- ["HTTP Uploads"](/docs/demos/net/upload) covers uploading files
- ["HTTP Server Processing"](/docs/demos/net/server) covers HTTP servers
:::
network
2022-08-05 05:10:11 +00:00
:::caution Third-Party Hosts and Binary Data
upload
2023-11-20 02:51:39 +00:00
Third-party cloud platforms such as AWS may corrupt raw binary downloads by
encoding requests and responses in UTF-8 strings.
network
2022-08-05 05:10:11 +00:00
For AWS, in the "Binary Media Types" section of the API Gateway console, the
upload
2023-11-20 02:51:39 +00:00
`"application/vnd.ms-excel"` type should be added to ensure that AWS Lambda
functions functions can send files to clients.
network
2022-08-05 05:10:11 +00:00
:::
## Downloading Binary Data
Most interesting spreadsheet files are binary data that contain byte sequences
that represent invalid UTF-8 characters.
netsuite-amd
2024-01-17 20:22:38 +00:00
APIs generally provide options to control how downloaded data is interpreted.
The `arraybuffer` response type usually forces the data to be presented as an
`ArrayBuffer` object which can be parsed with the SheetJS `read` method[^1].
network
2022-08-05 05:10:11 +00:00
math
2024-01-03 06:47:00 +00:00
The following example shows the data flow using `fetch` to download files:
```mermaid
flowchart LR
server[(Remote\nFile)]
response(Response\nobject)
subgraph SheetJS operations
ab(XLSX Data\nArrayBuffer)
wb(((SheetJS\nWorkbook)))
end
server --> |`fetch`\nGET request| response
response --> |`arrayBuffer`\n\n| ab
ab --> |`read`\n\n| wb
```
network
2022-08-05 05:10:11 +00:00
```js
upload
2023-11-20 02:51:39 +00:00
/* download data into an ArrayBuffer object */
network
2022-08-05 05:10:11 +00:00
const res = await fetch("https://sheetjs.com/pres.numbers");
tauri
2022-08-14 02:10:41 +00:00
const ab = await res.arrayBuffer(); // recover data as ArrayBuffer
network
2022-08-05 05:10:11 +00:00
upload
2023-11-20 02:51:39 +00:00
/* parse file */
network
2022-08-05 05:10:11 +00:00
const wb = XLSX.read(ab);
```
## Browser Demos
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 04:47:04 +00:00
When the page is accessed, the browser will attempt to download https://sheetjs.com/pres.numbers
upload
2023-11-20 02:51:39 +00:00
and read the workbook. The old table will be replaced with a table whose
contents match the first worksheet. The table is generated using the SheetJS
`sheet_to_html` method[^2]
network
2022-08-05 05:10:11 +00:00
netsuite-amd
2024-01-17 20:22:38 +00:00
:::note Tested Deployments
Each browser demo was tested in the following environments:
| Browser | Date |
|:------------|:-----------|
useeffect-async
2024-01-31 08:14:07 +00:00
| Chrome 120 | 2024-01-30 |
netsuite-amd
2024-01-17 20:22:38 +00:00
| Safari 17.2 | 2024-01-15 |
:::
network
2022-08-05 05:10:11 +00:00
### XMLHttpRequest
For downloading data, the `arraybuffer` response type generates an `ArrayBuffer`
math
2024-01-03 06:47:00 +00:00
that can be viewed as an `Uint8Array` and fed to the SheetJS `read` method. For
legacy browsers, the option `type: "array"` should be specified:
network
2022-08-05 05:10:11 +00:00
```js
/* set up an async GET request */
var req = new XMLHttpRequest();
req.open("GET", url, true);
req.responseType = "arraybuffer";
req.onload = function(e) {
/* parse the data when it is received */
var data = new Uint8Array(req.response);
var workbook = XLSX.read(data, {type:"array"});
/* DO SOMETHING WITH workbook HERE */
};
req.send();
```
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 04:47:04 +00:00
<details>
<summary><b>Live Download demo</b> (click to show)</summary>
network
2022-08-05 05:10:11 +00:00
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 04:47:04 +00:00
This demo uses `XMLHttpRequest` to download https://sheetjs.com/pres.numbers
network
2022-08-05 05:10:11 +00:00
and show the data in an HTML table.
```jsx live
function SheetJSXHRDL() {
WPS 电子表格
2022-10-21 00:10:10 +00:00
const [__html, setHTML] = React.useState("");
network
2022-08-05 05:10:11 +00:00
/* Fetch and update HTML */
useeffect-async
2024-01-31 08:14:07 +00:00
React.useEffect(() => { (async() => {
network
2022-08-05 05:10:11 +00:00
/* Fetch file */
const req = new XMLHttpRequest();
req.open("GET", "https://sheetjs.com/pres.numbers", true);
req.responseType = "arraybuffer";
req.onload = e => {
/* Parse file */
const wb = XLSX.read(new Uint8Array(req.response));
const ws = wb.Sheets[wb.SheetNames[0]];
/* Generate HTML */
setHTML(XLSX.utils.sheet_to_html(ws));
};
req.send();
useeffect-async
2024-01-31 08:14:07 +00:00
})(); }, []);
network
2022-08-05 05:10:11 +00:00
react
2023-02-28 11:40:44 +00:00
return ( <div dangerouslySetInnerHTML={{ __html }}/> );
network
2022-08-05 05:10:11 +00:00
}
```
</details>
### fetch
For downloading data, `Response#arrayBuffer` resolves to an `ArrayBuffer` that
math
2024-01-03 06:47:00 +00:00
can be converted to `Uint8Array` and passed to the SheetJS `read` method:
network
2022-08-05 05:10:11 +00:00
```js
fetch(url).then(function(res) {
/* get the data as a Blob */
if(!res.ok) throw new Error("fetch failed");
return res.arrayBuffer();
}).then(function(ab) {
/* parse the data when it is received */
var data = new Uint8Array(ab);
var workbook = XLSX.read(data, {type:"array"});
/* DO SOMETHING WITH workbook HERE */
});
```
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 04:47:04 +00:00
<details>
<summary><b>Live Download demo</b> (click to show)</summary>
network
2022-08-05 05:10:11 +00:00
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 04:47:04 +00:00
This demo uses `fetch` to download https://sheetjs.com/pres.numbers and show
network
2022-08-05 05:10:11 +00:00
the data in an HTML table.
```jsx live
function SheetJSFetchDL() {
WPS 电子表格
2022-10-21 00:10:10 +00:00
const [__html, setHTML] = React.useState("");
network
2022-08-05 05:10:11 +00:00
/* Fetch and update HTML */
useeffect-async
2024-01-31 08:14:07 +00:00
React.useEffect(() => { (async() => {
network
2022-08-05 05:10:11 +00:00
/* Fetch file */
const res = await fetch("https://sheetjs.com/pres.numbers");
const ab = await res.arrayBuffer();
/* Parse file */
const wb = XLSX.read(ab);
const ws = wb.Sheets[wb.SheetNames[0]];
/* Generate HTML */
setHTML(XLSX.utils.sheet_to_html(ws));
useeffect-async
2024-01-31 08:14:07 +00:00
})(); }, []);
network
2022-08-05 05:10:11 +00:00
react
2023-02-28 11:40:44 +00:00
return ( <div dangerouslySetInnerHTML={{ __html }}/> );
network
2022-08-05 05:10:11 +00:00
}
```
</details>
jQuery.ajax
2023-03-20 18:30:42 +00:00
### jQuery
contributing
2023-08-30 03:44:38 +00:00
[jQuery](https://jquery.com/) is a JavaScript library that includes helpers for
performing "Ajax" network requests. `jQuery.ajax` (`$.ajax`) does not support
upload
2023-11-20 02:51:39 +00:00
binary data out of the box[^3]. A custom `ajaxTransport` can add support.
contributing
2023-08-30 03:44:38 +00:00
upload
2023-11-20 02:51:39 +00:00
SheetJS users have reported success with `jquery.binarytransport.js`[^4] in IE10.
jQuery.ajax
2023-03-20 18:30:42 +00:00
After including the main `jquery.js` and `jquery.binarytransport.js` scripts,
`$.ajax` will support `dataType: "binary"` and `processData: false`.
**[Live Download Demo](pathname:///jquery/index.html)**
In a GET request, the default behavior is to return a `Blob` object. Passing
`responseType: "arraybuffer"` returns a proper `ArrayBuffer` object in IE10:
```js
$.ajax({
type: "GET", url: "https://sheetjs.com/pres.numbers",
/* suppress jQuery post-processing */
// highlight-next-line
processData: false,
/* use the binary transport */
// highlight-next-line
dataType: "binary",
/* pass an ArrayBuffer in the callback */
// highlight-next-line
responseType: "arraybuffer",
success: function (ab) {
/* at this point, ab is an ArrayBuffer */
// highlight-next-line
var wb = XLSX.read(ab);
/* do something with workbook here */
var ws = wb.Sheets[wb.SheetNames[0]];
var html = XLSX.utils.sheet_to_html(ws);
$("#out").html(html);
}
});
```
network
2022-08-05 05:10:11 +00:00
### Wrapper Libraries
Before `fetch` shipped with browsers, there were various wrapper libraries to
math
2024-01-03 06:47:00 +00:00
simplify `XMLHttpRequest`. Due to limitations with `fetch`, these libraries are
still relevant.
network
2022-08-05 05:10:11 +00:00
#### axios
contributing
2023-08-30 03:44:38 +00:00
[`axios`](https://axios-http.com/) presents a Promise based interface. Setting
math
2024-01-03 06:47:00 +00:00
`responseType` to `arraybuffer` ensures the return type is an ArrayBuffer. The
`data` property of the result can be passed to the SheetJS `read` method:
network
2022-08-05 05:10:11 +00:00
```js
async function workbook_dl_axios(url) {
const res = await axios(url, {responseType:'arraybuffer'});
const workbook = XLSX.read(res.data);
return workbook;
}
```
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 04:47:04 +00:00
<details>
<summary><b>Live Download demo</b> (click to show)</summary>
network
2022-08-05 05:10:11 +00:00
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 04:47:04 +00:00
This demo uses `axios` to download https://sheetjs.com/pres.numbers and show
network
2022-08-05 05:10:11 +00:00
the data in an HTML table.
knex
2023-09-24 03:59:48 +00:00
:::caution pass
astro
2023-02-18 02:33:30 +00:00
If the live demo shows a message
```
ReferenceError: axios is not defined
```
please refresh the page. This is a known bug in the documentation generator.
:::
network
2022-08-05 05:10:11 +00:00
```jsx live
function SheetJSAxiosDL() {
WPS 电子表格
2022-10-21 00:10:10 +00:00
const [__html, setHTML] = React.useState("");
network
2022-08-05 05:10:11 +00:00
/* Fetch and update HTML */
useeffect-async
2024-01-31 08:14:07 +00:00
React.useEffect(() => { (async() => {
ns-http
2023-05-21 07:03:46 +00:00
if(typeof axios != "function") return setHTML("ReferenceError: axios is not defined");
network
2022-08-05 05:10:11 +00:00
/* Fetch file */
const res = await axios("https://sheetjs.com/pres.numbers", {responseType: "arraybuffer"});
/* Parse file */
const wb = XLSX.read(res.data);
const ws = wb.Sheets[wb.SheetNames[0]];
/* Generate HTML */
setHTML(XLSX.utils.sheet_to_html(ws));
useeffect-async
2024-01-31 08:14:07 +00:00
})(); }, []);
network
2022-08-05 05:10:11 +00:00
react
2023-02-28 11:40:44 +00:00
return ( <div dangerouslySetInnerHTML={{ __html }}/> );
network
2022-08-05 05:10:11 +00:00
}
```
</details>
content
2022-08-13 22:01:26 +00:00
#### superagent
network
2022-08-05 05:10:11 +00:00
netsuite-amd
2024-01-17 20:22:38 +00:00
[`superagent`](https://ladjs.github.io/superagent/) is a network request library
with a "Fluent Interface". Calling the `responseType` method with
contributing
2023-08-30 03:44:38 +00:00
`"arraybuffer"` will ensure the final response object is an `ArrayBuffer`:
network
2022-08-05 05:10:11 +00:00
```js
/* set up an async GET request with superagent */
contributing
2023-08-30 03:44:38 +00:00
superagent
.get(url)
.responseType('arraybuffer')
.end(function(err, res) {
/* parse the data when it is received */
var data = new Uint8Array(res.body);
var workbook = XLSX.read(data, {type:"array"});
/* DO SOMETHING WITH workbook HERE */
});
network
2022-08-05 05:10:11 +00:00
```
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 04:47:04 +00:00
<details>
<summary><b>Live Download demo</b> (click to show)</summary>
network
2022-08-05 05:10:11 +00:00
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 04:47:04 +00:00
This demo uses `superagent` to download https://sheetjs.com/pres.numbers and
network
2022-08-05 05:10:11 +00:00
show the data in an HTML table.
knex
2023-09-24 03:59:48 +00:00
:::caution pass
astro
2023-02-18 02:33:30 +00:00
If the live demo shows a message
```
ReferenceError: superagent is not defined
```
please refresh the page. This is a known bug in the documentation generator.
:::
network
2022-08-05 05:10:11 +00:00
```jsx live
function SheetJSSuperAgentDL() {
WPS 电子表格
2022-10-21 00:10:10 +00:00
const [__html, setHTML] = React.useState("");
network
2022-08-05 05:10:11 +00:00
/* Fetch and update HTML */
useeffect-async
2024-01-31 08:14:07 +00:00
React.useEffect(() => { (async() => {
ns-http
2023-05-21 07:03:46 +00:00
if(typeof superagent == "undefined" || typeof superagent.get != "function")
return setHTML("ReferenceError: superagent is not defined");
network
2022-08-05 05:10:11 +00:00
/* Fetch file */
superagent
.get("https://sheetjs.com/pres.numbers")
.responseType("arraybuffer")
.end((err, res) => {
/* Parse file */
const wb = XLSX.read(res.body);
const ws = wb.Sheets[wb.SheetNames[0]];
/* Generate HTML */
setHTML(XLSX.utils.sheet_to_html(ws));
});
useeffect-async
2024-01-31 08:14:07 +00:00
})(); }, []);
network
2022-08-05 05:10:11 +00:00
react
2023-02-28 11:40:44 +00:00
return ( <div dangerouslySetInnerHTML={{ __html }}/> );
network
2022-08-05 05:10:11 +00:00
}
```
</details>
express
2022-08-21 00:46:10 +00:00
## NodeJS Demos
gatsby
2022-11-11 08:53:04 +00:00
These examples show how to download data in NodeJS.
express
2022-08-21 00:46:10 +00:00
gatsby
2022-11-11 08:53:04 +00:00
### HTTPS GET
The `https` module provides a low-level `get` method for HTTPS GET requests:
ns-http
2023-05-21 07:03:46 +00:00
```js title="SheetJSHTTPSGet.js"
gatsby
2022-11-11 08:53:04 +00:00
var https = require("https"), XLSX = require("xlsx");
https.get('https://sheetjs.com/pres.numbers', function(res) {
var bufs = [];
res.on('data', function(chunk) { bufs.push(chunk); });
res.on('end', function() {
var buf = Buffer.concat(bufs);
var wb = XLSX.read(buf);
/* print the first worksheet to console */
var ws = wb.Sheets[wb.SheetNames[0]];
console.log(XLSX.utils.sheet_to_csv(ws));
});
});
```
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 04:47:04 +00:00
<details>
<summary><b>Complete Example</b> (click to show)</summary>
ns-http
2023-05-21 07:03:46 +00:00
jerry
2024-01-23 09:26:06 +00:00
:::note Tested Environments
ns-http
2023-05-21 07:03:46 +00:00
netsuite-amd
2024-01-17 20:22:38 +00:00
This demo was last tested on 2024 January 15 against NodeJS `20.11.0`
ns-http
2023-05-21 07:03:46 +00:00
:::
1) Install the [NodeJS module](/docs/getting-started/installation/nodejs)
<CodeBlock language="bash">{`\
npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`}
</CodeBlock>
2) Copy the `SheetJSHTTPSGet.js` code snippet to a file `SheetJSHTTPSGet.js`
netsuite-amd
2024-01-17 20:22:38 +00:00
3) Run the script:
```bash
node SheetJSHTTPSGet.js
```
If successful, the script will print CSV contents of the test file.
ns-http
2023-05-21 07:03:46 +00:00
</details>
gatsby
2022-11-11 08:53:04 +00:00
### fetch
netsuite-amd
2024-01-17 20:22:38 +00:00
:::caution pass
Experimental support for `fetch` was introduced in NodeJS `16.15.0`. It will be
considered stable in NodeJS LTS version `22`.
:::
gatsby
2022-11-11 08:53:04 +00:00
The `fetch` implementation has the same return types as the browser version:
```js
async function parse_from_url(url) {
const res = await fetch(url);
if(!res.ok) throw new Error("fetch failed");
const ab = await res.arrayBuffer();
const workbook = XLSX.read(ab);
return workbook;
}
```
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 04:47:04 +00:00
<details>
<summary><b>Complete Example</b> (click to show)</summary>
ns-http
2023-05-21 07:03:46 +00:00
jerry
2024-01-23 09:26:06 +00:00
:::note Tested Environments
ns-http
2023-05-21 07:03:46 +00:00
netsuite-amd
2024-01-17 20:22:38 +00:00
This demo was last tested on 2024 January 15 against NodeJS `20.11.0`
ns-http
2023-05-21 07:03:46 +00:00
:::
1) Install the [NodeJS module](/docs/getting-started/installation/nodejs)
<CodeBlock language="bash">{`\
npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`}
</CodeBlock>
2) Save the following to `SheetJSFetch.js`:
```js title="SheetJSFetch.js"
var XLSX = require("xlsx");
async function parse_from_url(url) {
const res = await fetch(url);
if(!res.ok) throw new Error("fetch failed");
const ab = await res.arrayBuffer();
const workbook = XLSX.read(ab);
return workbook;
}
(async() => {
const wb = await parse_from_url('https://sheetjs.com/pres.numbers');
/* print the first worksheet to console */
var ws = wb.Sheets[wb.SheetNames[0]];
console.log(XLSX.utils.sheet_to_csv(ws));
})();
```
netsuite-amd
2024-01-17 20:22:38 +00:00
3) Run the script:
```bash
node SheetJSFetch.js
```
If successful, the script will print CSV contents of the test file.
ns-http
2023-05-21 07:03:46 +00:00
</details>
gatsby
2022-11-11 08:53:04 +00:00
### Wrapper Libraries
The latest releases of NodeJS support `fetch` natively. Before `fetch` support
was added to the platform, third party modules wrapped the native APIs.
#### request
express
2022-08-21 00:46:10 +00:00
workarounds for docusaurus breaking changes
2024-04-14 07:40:38 +00:00
:::danger pass
express
2022-08-21 00:46:10 +00:00
`request` has been deprecated and should only be used in legacy deployments.
:::
Setting the option `encoding: null` passes raw buffers:
ns-http
2023-05-21 07:03:46 +00:00
```js title="SheetJSRequest.js"
express
2022-08-21 00:46:10 +00:00
var XLSX = require('xlsx'), request = require('request');
var url = 'https://sheetjs.com/pres.numbers';
/* call `request` with the option `encoding: null` */
// highlight-next-line
request(url, {encoding: null}, function(err, res, data) {
if(err || res.statusCode !== 200) return;
contributing
2023-08-30 03:44:38 +00:00
/* if the request was successful, parse the data */
express
2022-08-21 00:46:10 +00:00
// highlight-next-line
var wb = XLSX.read(data);
/* print the first worksheet to console */
var ws = wb.Sheets[wb.SheetNames[0]];
gatsby
2022-11-11 08:53:04 +00:00
console.log(XLSX.utils.sheet_to_csv(ws));
express
2022-08-21 00:46:10 +00:00
});
gatsby
2022-11-11 08:53:04 +00:00
```
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 04:47:04 +00:00
<details>
<summary><b>Complete Example</b> (click to show)</summary>
ns-http
2023-05-21 07:03:46 +00:00
jerry
2024-01-23 09:26:06 +00:00
:::note Tested Environments
ns-http
2023-05-21 07:03:46 +00:00
netsuite-amd
2024-01-17 20:22:38 +00:00
This demo was last tested on 2024 January 15 against request `2.88.2`
ns-http
2023-05-21 07:03:46 +00:00
:::
1) Install the [NodeJS module](/docs/getting-started/installation/nodejs)
<CodeBlock language="bash">{`\
npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz request@2.88.2`}
</CodeBlock>
2) Copy the `SheetJSRequest.js` code snippet to a file `SheetJSRequest.js`
netsuite-amd
2024-01-17 20:22:38 +00:00
3) Run the script:
```bash
node SheetJSRequest.js
```
If successful, the script will print CSV contents of the test file.
ns-http
2023-05-21 07:03:46 +00:00
</details>
gatsby
2022-11-11 08:53:04 +00:00
#### axios
When the `responseType` is `"arraybuffer"`, `axios` actually captures the data
math
2024-01-03 06:47:00 +00:00
in a NodeJS Buffer. The SheetJS `read` method handles NodeJS Buffer objects:
gatsby
2022-11-11 08:53:04 +00:00
ns-http
2023-05-21 07:03:46 +00:00
```js title="SheetJSAxios.js"
gatsby
2022-11-11 08:53:04 +00:00
const XLSX = require("xlsx"), axios = require("axios");
async function workbook_dl_axios(url) {
const res = await axios(url, {responseType:'arraybuffer'});
/* at this point, res.data is a Buffer */
const workbook = XLSX.read(res.data);
return workbook;
}
```
ns-http
2023-05-21 07:03:46 +00:00
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 04:47:04 +00:00
<details>
<summary><b>Complete Example</b> (click to show)</summary>
ns-http
2023-05-21 07:03:46 +00:00
jerry
2024-01-23 09:26:06 +00:00
:::note Tested Environments
ns-http
2023-05-21 07:03:46 +00:00
netsuite-amd
2024-01-17 20:22:38 +00:00
This demo was last tested on 2024 January 15 against Axios `1.6.5`
ns-http
2023-05-21 07:03:46 +00:00
:::
1) Install the [NodeJS module](/docs/getting-started/installation/nodejs)
<CodeBlock language="bash">{`\
netsuite-amd
2024-01-17 20:22:38 +00:00
npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz axios@1.6.5`}
ns-http
2023-05-21 07:03:46 +00:00
</CodeBlock>
2) Save the following to `SheetJSAxios.js`:
```js title="SheetJSAxios.js"
const XLSX = require("xlsx"), axios = require("axios");
async function workbook_dl_axios(url) {
const res = await axios(url, {responseType:'arraybuffer'});
/* at this point, res.data is a Buffer */
const workbook = XLSX.read(res.data);
return workbook;
}
(async() => {
const wb = await workbook_dl_axios('https://sheetjs.com/pres.numbers');
/* print the first worksheet to console */
var ws = wb.Sheets[wb.SheetNames[0]];
console.log(XLSX.utils.sheet_to_csv(ws));
})();
```
netsuite-amd
2024-01-17 20:22:38 +00:00
3) Run the script:
```bash
node SheetJSAxios.js
```
If successful, the script will print CSV contents of the test file.
ns-http
2023-05-21 07:03:46 +00:00
</details>
## Other Platforms
Other demos show network operations in special platforms:
- [React Native "Fetching Remote Data"](/docs/demos/mobile/reactnative#fetching-remote-data)
- [NativeScript "Fetching Remote Files"](/docs/demos/mobile/nativescript#fetching-remote-files)
math
2024-01-03 06:47:00 +00:00
- [AngularJS "Remote Files"](/docs/demos/frontend/angularjs#remote-files)
- [Dojo Toolkit "Parsing Remote Files"](/docs/demos/frontend/dojo#parsing-remote-files)
contributing
2023-08-30 03:44:38 +00:00
upload
2023-11-20 02:51:39 +00:00
[^1]: See [`read` in "Reading Files"](/docs/api/parse-options)
[^2]: See [`sheet_to_html` in "Utilities"](/docs/api/utilities/html#html-table-output)
[^3]: See [`dataType` in `jQuery.ajax`](https://api.jquery.com/jQuery.ajax/) in the official jQuery documentation.
[^4]: See [the official `jquery.binarytransport.js` repo](https://github.com/henrya/js-jquery/tree/master/BinaryTransport) for more details.
Copy Permalink