Skip to content

Deprecate createInputStream #1209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 8, 2020
Merged

Deprecate createInputStream #1209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
114ae91
Deprecate createInputStream
alubbe Apr 8, 2020
c41880e
add jsDoc @depracated annotation
Siemienik Apr 8, 2020
97c853b
add JsDoc @deprecated annotation
Siemienik Apr 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 29 additions & 65 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1932,44 +1932,34 @@ faster or more resilient.
```javascript
// read from a file
var workbook = new Excel.Workbook();
workbook.xlsx.readFile(filename)
.then(function() {
// use workbook
});
await workbook.xlsx.readFile(filename);
// ... use workbook

// pipe from stream

// read from a stream
var workbook = new Excel.Workbook();
stream.pipe(workbook.xlsx.createInputStream());
await workbook.xlsx.read(stream);
// ... use workbook


// load from buffer
var workbook = new Excel.Workbook();
workbook.xlsx.load(data)
.then(function() {
// use workbook
});
await workbook.xlsx.load(data);
// ... use workbook
```

#### Writing XLSX

```javascript
// write to a file
var workbook = createAndFillWorkbook();
workbook.xlsx.writeFile(filename)
.then(function() {
// done
});
await workbook.xlsx.writeFile(filename);

// write to a stream
workbook.xlsx.write(stream)
.then(function() {
// done
});
await workbook.xlsx.write(stream);

// write to a new buffer
workbook.xlsx.writeBuffer()
.then(function(buffer) {
// done
});
const buffer = await workbook.xlsx.writeBuffer();
```

### CSV
Expand All @@ -1988,31 +1978,24 @@ Options supported when reading CSV files.
```javascript
// read from a file
var workbook = new Excel.Workbook();
workbook.csv.readFile(filename)
.then(worksheet => {
// use workbook or worksheet
});
const worksheet = await workbook.csv.readFile(filename);
// ... use workbook or worksheet


// read from a stream
var workbook = new Excel.Workbook();
workbook.csv.read(stream)
.then(worksheet => {
// use workbook or worksheet
});
const worksheet = await workbook.csv.read(stream);
// ... use workbook or worksheet

// pipe from stream
var workbook = new Excel.Workbook();
stream.pipe(workbook.csv.createInputStream());

// read from a file with European Dates
var workbook = new Excel.Workbook();
var options = {
dateFormats: ['DD/MM/YYYY']
};
workbook.csv.readFile(filename, options)
.then(worksheet => {
// use workbook or worksheet
});
const worksheet = await workbook.csv.readFile(filename, options);
// ... use workbook or worksheet


// read from a file with custom value parsing
var workbook = new Excel.Workbook();
Expand All @@ -2039,10 +2022,8 @@ var options = {
quote: false,
},
};
workbook.csv.readFile(filename, options)
.then(function(worksheet) {
// use workbook or worksheet
});
const worksheet = await workbook.csv.readFile(filename, options);
// ... use workbook or worksheet
```

The CSV parser uses [fast-csv](https://www.npmjs.com/package/fast-csv) to read the CSV file.
Expand Down Expand Up @@ -2077,29 +2058,20 @@ Options supported when writing to a CSV file.

// write to a file
var workbook = createAndFillWorkbook();
workbook.csv.writeFile(filename)
.then(() => {
// done
});
await workbook.csv.writeFile(filename);

// write to a stream
// Be careful that you need to provide sheetName or
// sheetId for correct import to csv.
workbook.csv.write(stream, { sheetName: 'Page name' })
.then(() => {
// done
});
await workbook.csv.write(stream, { sheetName: 'Page name' });

// write to a file with European Date-Times
var workbook = new Excel.Workbook();
var options = {
dateFormat: 'DD/MM/YYYY HH:mm:ss',
dateUTC: true, // use utc when rendering dates
};
workbook.csv.writeFile(filename, options)
.then(() => {
// done
});
await workbook.csv.writeFile(filename, options);


// write to a file with custom value formatting
Expand Down Expand Up @@ -2127,16 +2099,10 @@ var options = {
quote: false,
},
};
workbook.csv.writeFile(filename, options)
.then(() => {
// done
});
await workbook.csv.writeFile(filename, options);

// write to a new buffer
workbook.csv.writeBuffer()
.then(function(buffer) {
// done
});
const buffer = await workbook.csv.writeBuffer();
```

The CSV parser uses [fast-csv](https://www.npmjs.com/package/fast-csv) to write the CSV file.
Expand Down Expand Up @@ -2242,10 +2208,8 @@ To complete the XLSX document, the workbook must be committed. If any worksheet

```javascript
// Finished the workbook.
workbook.commit()
.then(function() {
// the stream has been written
});
await workbook.commit();
// ... the stream has been written
```

# Browser
Expand Down
96 changes: 30 additions & 66 deletions README_zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1352,44 +1352,34 @@ worksheet.addImage(imageId2, {
```javascript
// read from a file
var workbook = new Excel.Workbook();
workbook.xlsx.readFile(filename)
.then(function() {
// use workbook
});
await workbook.xlsx.readFile(filename);
// ... use workbook

// pipe from stream

// read from a stream
var workbook = new Excel.Workbook();
stream.pipe(workbook.xlsx.createInputStream());
await workbook.xlsx.read(stream);
// ... use workbook


// load from buffer
var workbook = new Excel.Workbook();
workbook.xlsx.load(data)
.then(function() {
// use workbook
});
await workbook.xlsx.load(data);
// ... use workbook
```

#### <a id="writing-xlsx">写 XLSX</a>

```javascript
````javascript
// write to a file
var workbook = createAndFillWorkbook();
workbook.xlsx.writeFile(filename)
.then(function() {
// done
});
await workbook.xlsx.writeFile(filename);

// write to a stream
workbook.xlsx.write(stream)
.then(function() {
// done
});
await workbook.xlsx.write(stream);

// write to a new buffer
workbook.xlsx.writeBuffer()
.then(function(buffer) {
// done
});
const buffer = await workbook.xlsx.writeBuffer();
```

### CSV <a id="csv">CSV</a>
Expand All @@ -1408,31 +1398,24 @@ workbook.xlsx.writeBuffer()
```javascript
// read from a file
var workbook = new Excel.Workbook();
workbook.csv.readFile(filename)
.then(worksheet => {
// use workbook or worksheet
});
const worksheet = await workbook.csv.readFile(filename);
// ... use workbook or worksheet


// read from a stream
var workbook = new Excel.Workbook();
workbook.csv.read(stream)
.then(worksheet => {
// use workbook or worksheet
});
const worksheet = await workbook.csv.read(stream);
// ... use workbook or worksheet

// pipe from stream
var workbook = new Excel.Workbook();
stream.pipe(workbook.csv.createInputStream());

// read from a file with European Dates
var workbook = new Excel.Workbook();
var options = {
dateFormats: ['DD/MM/YYYY']
};
workbook.csv.readFile(filename, options)
.then(worksheet => {
// use workbook or worksheet
});
const worksheet = await workbook.csv.readFile(filename, options);
// ... use workbook or worksheet


// read from a file with custom value parsing
var workbook = new Excel.Workbook();
Expand All @@ -1459,10 +1442,8 @@ var options = {
quote: false,
},
};
workbook.csv.readFile(filename, options)
.then(function(worksheet) {
// use workbook or worksheet
});
const worksheet = await workbook.csv.readFile(filename, options);
// ... use workbook or worksheet
```

CSV解析器使用[fast-csv](https://www.npmjs.com/package/fast-csv)来读取CSV文件。
Expand Down Expand Up @@ -1496,29 +1477,20 @@ CSV解析器使用[fast-csv](https://www.npmjs.com/package/fast-csv)来读取CSV

// write to a file
var workbook = createAndFillWorkbook();
workbook.csv.writeFile(filename)
.then(() => {
// done
});
await workbook.csv.writeFile(filename);

// write to a stream
// Be careful that you need to provide sheetName or
// sheetId for correct import to csv.
workbook.csv.write(stream, { sheetName: 'Page name' })
.then(() => {
// done
});
await workbook.csv.write(stream, { sheetName: 'Page name' });

// write to a file with European Date-Times
var workbook = new Excel.Workbook();
var options = {
dateFormat: 'DD/MM/YYYY HH:mm:ss',
dateUTC: true, // use utc when rendering dates
};
workbook.csv.writeFile(filename, options)
.then(() => {
// done
});
await workbook.csv.writeFile(filename, options);


// write to a file with custom value formatting
Expand Down Expand Up @@ -1546,16 +1518,10 @@ var options = {
quote: false,
},
};
workbook.csv.writeFile(filename, options)
.then(() => {
// done
});
await workbook.csv.writeFile(filename, options);

// write to a new buffer
workbook.csv.writeBuffer()
.then(function(buffer) {
// done
});
const buffer = await workbook.csv.writeBuffer();
```

CSV解析器使用[fast-csv]（https://www.npmjs.com/package/fast-csv）编写CSV文件。
Expand Down Expand Up @@ -1660,10 +1626,8 @@ worksheet.commit();

```javascript
// Finished the workbook.
workbook.commit()
.then(function() {
// the stream has been written
});
await workbook.commit();
// ... the stream has been written
```

# <a id="browser">浏览器</a>
Expand Down
10 changes: 9 additions & 1 deletion lib/csv/csv.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,23 @@ class CSV {
read(stream, options) {
options = options || {};
return new Promise((resolve, reject) => {
const csvStream = this.createInputStream(options)
const csvStream = this._createInputStream(options)
.on('worksheet', resolve)
.on('error', reject);

stream.pipe(csvStream);
});
}

/**
* @deprecated since version 4.0. You should use `CSV#read` instead. Please follow upgrade instruction: https://github.com/exceljs/exceljs/blob/master/UPGRADE-4.0.md
*/
createInputStream(options) {
console.warn('`CSV#createInputStream` is deprecated. You should use `CSV#read` instead. This method will be removed in version 4.0. Please follow upgrade instruction: https://github.com/exceljs/exceljs/blob/master/UPGRADE-4.0.md');
return this._createInputStream(options);
}

_createInputStream(options) {
options = options || {};
const worksheet = this.workbook.addWorksheet(options.sheetName);

Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy