2022-05-16 03:26:04 +00:00
---
2022-08-24 23:48:22 +00:00
pagination_prev: getting-started/index
2023-07-26 20:18:07 +00:00
pagination_next: getting-started/examples/index
2022-08-31 06:46:03 +00:00
sidebar_position: 3
2022-05-16 03:26:04 +00:00
sidebar_custom_props:
summary: Server-side and other frameworks using NodeJS modules
---
import current from '/version.js';
2023-05-26 22:50:23 +00:00
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
2023-04-29 11:21:37 +00:00
import CodeBlock from '@theme/CodeBlock';
2022-05-16 03:26:04 +00:00
# NodeJS
Tarballs are available on < https: / / cdn . sheetjs . com > .
2023-05-07 13:58:36 +00:00
< p > < a href = {`https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} > https://cdn.sheetjs.com/xlsx-{current}/xlsx-{current}.tgz< / a > is the URL for version {current}< / p >
2022-05-16 03:26:04 +00:00
## Installation
Tarballs can be directly installed using a package manager:
2023-05-07 13:58:36 +00:00
< Tabs groupId = "pm" >
2022-05-16 03:26:04 +00:00
< TabItem value = "npm" label = "npm" >
2023-05-07 13:58:36 +00:00
< CodeBlock language = "bash" > {`\
2022-08-07 07:48:40 +00:00
npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`}
2023-05-07 13:58:36 +00:00
< / CodeBlock >
2022-05-16 03:26:04 +00:00
< / TabItem >
< TabItem value = "pnpm" label = "pnpm" >
2023-05-07 13:58:36 +00:00
< CodeBlock language = "bash" > {`\
2022-08-07 07:48:40 +00:00
pnpm install https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`}
2023-05-07 13:58:36 +00:00
< / CodeBlock >
2022-05-16 03:26:04 +00:00
< / TabItem >
< TabItem value = "yarn" label = "Yarn" default >
2023-05-07 13:58:36 +00:00
< CodeBlock language = "bash" > {`\
2022-08-07 07:48:40 +00:00
yarn add https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`}
2023-05-07 13:58:36 +00:00
< / CodeBlock >
2022-05-16 03:26:04 +00:00
< / TabItem >
< / Tabs >
2023-06-25 09:36:58 +00:00
:::tip pass
2023-04-27 09:12:19 +00:00
[Watch the repo ](https://git.sheetjs.com/SheetJS/sheetjs ) or subscribe to the
[RSS feed ](https://git.sheetjs.com/sheetjs/sheetjs/tags.rss ) to be notified when
new versions are released!
:::
2023-09-05 18:04:23 +00:00
### Legacy Endpoints
2022-07-25 23:18:00 +00:00
:::warning
Older releases are technically available on the public npm registry as `xlsx` ,
but the registry is out of date. The latest version on that registry is 0.18.5
This is a known registry bug
2023-09-17 04:57:06 +00:00
**The SheetJS CDN** < https: // cdn . sheetjs . com /> **is the authoritative source**
**for SheetJS modules.**
2022-07-25 23:18:00 +00:00
For existing projects, the easiest approach is to uninstall and reinstall:
2023-05-07 13:58:36 +00:00
< Tabs groupId = "pm" >
2022-07-25 23:18:00 +00:00
< TabItem value = "npm" label = "npm" >
2023-05-07 13:58:36 +00:00
< CodeBlock language = "bash" > {`\
2022-08-07 07:48:40 +00:00
npm rm --save xlsx
2023-03-12 06:25:57 +00:00
npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`}
2023-05-07 13:58:36 +00:00
< / CodeBlock >
2022-07-25 23:18:00 +00:00
< / TabItem >
< TabItem value = "pnpm" label = "pnpm" >
2023-05-07 13:58:36 +00:00
< CodeBlock language = "bash" > {`\
2022-08-07 07:48:40 +00:00
pnpm rm xlsx
2023-03-12 06:25:57 +00:00
pnpm install https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`}
2023-05-07 13:58:36 +00:00
< / CodeBlock >
2022-07-25 23:18:00 +00:00
< / TabItem >
< TabItem value = "yarn" label = "Yarn" default >
2023-05-07 13:58:36 +00:00
< CodeBlock language = "bash" > {`\
2022-08-07 07:48:40 +00:00
yarn remove xlsx
2023-03-12 06:25:57 +00:00
yarn add https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`}
2023-05-07 13:58:36 +00:00
< / CodeBlock >
2022-07-25 23:18:00 +00:00
< / TabItem >
< / Tabs >
2023-04-29 11:21:37 +00:00
When the `xlsx` library is a dependency of a dependency, the `overrides` field
in `package.json` can control module resolution:
< CodeBlock language = "json" title = "package.json" > {`\
{
// highlight-start
"overrides": {
"xlsx": "https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz"
}
// highlight-end
}`}
< / CodeBlock >
2022-07-25 23:18:00 +00:00
:::
2022-05-16 03:26:04 +00:00
### Vendoring
For general stability, "vendoring" modules is the recommended approach:
2023-05-07 13:58:36 +00:00
< p > 1) Download the tarball (< code parentName = "pre" > xlsx-{current}.tgz< / code > ) for the desired version. The current
version is available at < a href = {`https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} > https://cdn.sheetjs.com/xlsx-{current}/xlsx-{current}.tgz< / a > < / p >
2022-05-16 03:26:04 +00:00
2022-08-23 03:20:02 +00:00
2) Create a `vendor` subfolder at the root of your project and move the tarball
to that folder. Add it to your project repository.
2022-05-16 03:26:04 +00:00
3) Install the tarball using a package manager:
2023-05-07 13:58:36 +00:00
< Tabs groupId = "pm" >
2022-05-16 03:26:04 +00:00
< TabItem value = "npm" label = "npm" >
2023-05-07 13:58:36 +00:00
< CodeBlock language = "bash" > {`\
2022-08-07 07:48:40 +00:00
npm i --save file:vendor/xlsx-${current}.tgz`}
2023-05-07 13:58:36 +00:00
< / CodeBlock >
2022-05-16 03:26:04 +00:00
< / TabItem >
< TabItem value = "pnpm" label = "pnpm" >
2023-05-07 13:58:36 +00:00
< CodeBlock language = "bash" > {`\
2022-08-07 07:48:40 +00:00
pnpm install file:vendor/xlsx-${current}.tgz`}
2023-05-07 13:58:36 +00:00
< / CodeBlock >
2022-05-16 03:26:04 +00:00
< / TabItem >
< TabItem value = "yarn" label = "Yarn" default >
2023-05-07 13:58:36 +00:00
< CodeBlock language = "bash" > {`\
2022-08-07 07:48:40 +00:00
yarn add file:vendor/xlsx-${current}.tgz`}
2023-05-07 13:58:36 +00:00
< / CodeBlock >
2022-05-16 03:26:04 +00:00
< / TabItem >
< / Tabs >
The package will be installed and accessible as `xlsx` .
## Usage
2022-06-05 22:43:44 +00:00
#### CommonJS `require`
2022-05-16 03:26:04 +00:00
By default, the module supports `require` and it will automatically add support
2022-08-25 08:22:28 +00:00
for streams and file system access:
2022-05-16 03:26:04 +00:00
```js
var XLSX = require("xlsx");
```
2022-06-05 22:43:44 +00:00
#### ESM `import`
2022-05-16 03:26:04 +00:00
The module also ships with `xlsx.mjs` for use with `import` . The `mjs` version
does not automatically load native node modules, so they must be added manually:
```js
2023-01-09 05:08:30 +00:00
import * as XLSX from 'xlsx';
2022-05-16 03:26:04 +00:00
/* load 'fs' for readFile and writeFile support */
import * as fs from 'fs';
XLSX.set_fs(fs);
/* load 'stream' for stream support */
import { Readable } from 'stream';
XLSX.stream.set_readable(Readable);
/* load the codepage support library for extended support with older formats */
import * as cpexcel from 'xlsx/dist/cpexcel.full.mjs';
XLSX.set_cptable(cpexcel);
```
2023-05-26 22:50:23 +00:00
#### NextJS
:::warning
`fs` cannot be imported from the top level in NextJS pages. This will not work:
```js
/* it is safe to import the library from the top level */
import { readFile, utils, set_fs } from 'xlsx';
/* it is not safe to import 'fs' from the top level ! */
// highlight-next-line
import * as fs from 'fs'; // this import will fail
set_fs(fs);
```
:::
`fs` should be loaded with a dynamic import within a lifecycle function:
```js title="index.js"
/* it is safe to import the library from the top level */
import { readFile, utils, set_fs } from 'xlsx';
import { join } from 'path';
import { cwd } from 'process';
export async function getServerSideProps() {
// highlight-next-line
set_fs(await import("fs")); // dynamically import 'fs' in `getServerSideProps`
const wb = readFile(join(cwd(), "public", "sheetjs.xlsx"));
// ...
}
```
The [NextJS demo ](/docs/demos/static/nextjs ) includes complete examples.