Skip to content

Commit 8e3c4b0

Browse files
committed
update README
1 parent 181e262 commit 8e3c4b0

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# cloudconvert-node
22

3-
This is the official Node.js SDK v2 for the [CloudConvert](https://cloudconvert.com/api/v2) **API v2**.
3+
This is the official Node.js SDK for the [CloudConvert](https://cloudconvert.com/api/v2) API v2.
44

55
[![Node.js Run Tests](https://github.com/cloudconvert/cloudconvert-node/actions/workflows/run-tests.yml/badge.svg)](https://github.com/cloudconvert/cloudconvert-node/actions/workflows/run-tests.yml)
66
[![npm](https://img.shields.io/npm/v/cloudconvert.svg)](https://www.npmjs.com/package/cloudconvert)
@@ -93,6 +93,9 @@ const inputFile = fs.createReadStream('./file.pdf');
9393
await cloudConvert.tasks.upload(uploadTask, inputFile, 'file.pdf');
9494
```
9595

96+
> **Note on custom streams**:
97+
The length of the stream needs to be known prior to uploading. The SDK tries to automatically detect the file size of file-based read streams. If you are using a custom stream, you might need to pass a `fileSize` as fourth parameter to the `upload()` method.
98+
9699
## Websocket Events
97100

98101
The node SDK can subscribe to events of the [CloudConvert socket.io API](https://cloudconvert.com/api/v2/socket#socket).

0 commit comments

Comments
 (0)