feat: Typing support for NodeJS Buffer in lib/index.d.ts #674
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I did not test these changes on a Browser engine, but for NodeJS it should work more consistent
Thank you, but I am a bit concerned that this might breaking the tus-js-client integration for people using the client in a browser environment. Could this lead to problems with TypeScript if its configured for browsers and does not know |
|
@Acconut Hi! No, this change will not break users' browser apps. Proof of conceptpackage.json {
"name": "tus-buffer",
"version": "1.0.0",
"private": true,
"license": "MIT",
"main": "src/index.ts",
"scripts": {
"dev": "webpack-dev-server",
"watch": "webpack --watch",
"build": "webpack"
},
"devDependencies": {
"@types/node": "^22.7.9",
"ts-loader": "^9.5.1",
"typescript": "^5.6.3",
"webpack": "^5.95.0",
"webpack-cli": "^5.1.4",
"webpack-dev-server": "^5.1.0"
},
"dependencies": {
"tus-js-client": "file:./../source/"
}
}tsconfig.json {
"target": "es5",
"lib": ["es5", "es6", "dom"],
"module": "es6",
"rootDir": "./",
"moduleResolution": "node",
"allowJs": true,
"sourceMap": true,
"outDir": "./dis",
"downlevelIteration": true,
"esModuleInterop": true,
"strict": true,
"noImplicitAny": true,
"skipLibCheck": true
}webpack.config.js const path = require('path');
module.exports = {
devtool: 'inline-source-map',
entry: './src/index.ts',
mode: 'development',
module: {
rules: [
{
test: /\.ts?$/,
use: 'ts-loader',
exclude: /node_modules/,
},
],
},
resolve: {
extensions: ['.tsx', '.ts', '.js'],
},
devServer: {
static: path.join(__dirname, 'dist'),
compress: false,
port: 4000,
},
output: {
filename: 'index.js',
path: path.resolve(__dirname, 'dist'),
},
};src/index.ts import { Upload } from 'tus-js-client';
let file: File | Blob | Buffer | Pick<ReadableStreamDefaultReader, 'read'>;
if (typeof window === 'undefined') {
file = Buffer.from('Hello Buffer!', 'utf-8');
} else {
file = new Blob(['Hello Blob!!!']);
}
const upload = new Upload(file, {
endpoint: 'https://tusd.tusdemo.net/files/',
metadata: {
filename: 'README.md',
filetype: 'text/plain',
},
onError(error) {
console.error('An error occurred:');
console.error(error);
},
onProgress(bytesUploaded, bytesTotal) {
const percentage = ((bytesUploaded / bytesTotal) * 100).toFixed(2);
console.log(bytesUploaded, bytesTotal, `${percentage}%`);
},
onSuccess() {
console.log('Upload finished:', upload.url);
},
});
setTimeout(() => {
upload.start();
}, 2000);dist/index.html <!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
<script src="index.js"></script>
</head>
<body>
<h1>Buffer...</h1>
</body>
</html>ResultBrowser: 
Node.js 
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@Acconut,
I did not test these changes on a Browser engine, but for NodeJS TypeScript support it should work more consistently
Issue reference: #289