Update readme's, CI, and tsconfig

Author: Murderlon

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ concurrency: ${{ github.workflow }}--${{ github.ref }}
 
 jobs:
   main:
-    name: Node.js LTS
+    name: Node.js 20
     runs-on: ubuntu-latest
 
     steps:
@@ -33,7 +33,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: lts/*
+          node-version: 20
 
       - name: Install dependencies
         run: npm ci --no-fund --no-audit

README.md

@@ -52,17 +52,17 @@ A standalone server which stores files on disk.
 > Try it yourself in [StackBlitz](https://stackblitz.com/edit/stackblitz-starters-zg6mgnuf?file=index.js)
 
 ```js
-const {Server} = require('@tus/server')
-const {FileStore} = require('@tus/file-store')
+const { Server } = require("@tus/server");
+const { FileStore } = require("@tus/file-store");
 
-const host = '127.0.0.1'
-const port = 1080
+const host = "127.0.0.1";
+const port = 1080;
 const server = new Server({
-  path: '/files',
-  datastore: new FileStore({directory: './files'}),
-})
+  path: "/files",
+  datastore: new FileStore({ directory: "./files" }),
+});
 
-server.listen({host, port})
+server.listen({ host, port });
 ```
 
 A tus server integrated into your existing Node.js server. `@tus/server` has no
@@ -124,7 +124,7 @@ All packages are fully typed with TypeScript.
 
 ## Compatibility
 
-All packages require Node.js 16.0+.
+All packages require Node.js 20+.
 
 ## Contribute
 
@@ -144,8 +144,7 @@ See
 [`@tus/azure-store`]: https://github.com/tus/tus-node-server/tree/main/packages/azure-store
 [extensions]: https://tus.io/protocols/resumable-upload.html#protocol-extensions
 [creation]: https://tus.io/protocols/resumable-upload.html#creation
-[creation with upload]:
-  https://tus.io/protocols/resumable-upload.html#creation-with-upload
+[creation with upload]: https://tus.io/protocols/resumable-upload.html#creation-with-upload
 [expiration]: https://tus.io/protocols/resumable-upload.html#expiration
 [checksum]: https://tus.io/protocols/resumable-upload.html#checksum
 [termination]: https://tus.io/protocols/resumable-upload.html#termination

packages/azure-store/README.md

@@ -16,7 +16,7 @@ Azure Store based on the Append Blob Client [Azure Blob AppendBlobClient](https:
 
 ## Install
 
-In Node.js (16.0+), install with npm:
+In Node.js (20+), install with npm:
 
 ```bash
 npm install @tus/azure-store
@@ -25,17 +25,17 @@ npm install @tus/azure-store
 ## Use
 
 ```js
-const {Server} = require('@tus/server')
-const {AzureStore} = require('@tus/azure-store')
+const { Server } = require("@tus/server");
+const { AzureStore } = require("@tus/azure-store");
 
 const server = new Server({
-  path: '/files',
+  path: "/files",
   datastore: new AzureStore({
-      account: process.env.AZURE_ACCOUNT_ID,
-      accountKey: process.env.AZURE_ACCOUNT_KEY,
-      containerName: process.env.AZURE_CONTAINER_NAME,
+    account: process.env.AZURE_ACCOUNT_ID,
+    accountKey: process.env.AZURE_ACCOUNT_KEY,
+    containerName: process.env.AZURE_CONTAINER_NAME,
   }),
-})
+});
 // ...
 ```
 
@@ -84,7 +84,7 @@ This package is fully typed with TypeScript.
 
 ## Compatibility
 
-This package requires Node.js 16.0+.
+This package requires Node.js 20+.
 
 ## Contribute
 
@@ -98,17 +98,12 @@ See
 
 [extensions]: https://tus.io/protocols/resumable-upload.html#protocol-extensions
 [creation]: https://tus.io/protocols/resumable-upload.html#creation
-[creation with upload]:
-  https://tus.io/protocols/resumable-upload.html#creation-with-upload
+[creation with upload]: https://tus.io/protocols/resumable-upload.html#creation-with-upload
 [expiration]: https://tus.io/protocols/resumable-upload.html#expiration
 [checksum]: https://tus.io/protocols/resumable-upload.html#checksum
 [termination]: https://tus.io/protocols/resumable-upload.html#termination
 [concatenation]: https://tus.io/protocols/resumable-upload.html#concatenation
-[`cleanUpExpiredUploads`]:
-  https://github.com/tus/tus-node-server/tree/main/packages/server#cleanupexpireduploads
+[`cleanUpExpiredUploads`]: https://github.com/tus/tus-node-server/tree/main/packages/server#cleanupexpireduploads
 [kvstores]: https://github.com/tus/tus-node-server/tree/main/packages/server#kvstores
-[`KvStore`]:
-  https://github.com/tus/tus-node-server/blob/main/packages/utils/src/kvstores/Types.ts
-
-[`MemoryKvStore`]:
- https://github.com/tus/tus-node-server/blob/main/packages/utils/src/kvstores/MemoryKvStore.ts
+[`KvStore`]: https://github.com/tus/tus-node-server/blob/main/packages/utils/src/kvstores/Types.ts
+[`MemoryKvStore`]: https://github.com/tus/tus-node-server/blob/main/packages/utils/src/kvstores/MemoryKvStore.ts

packages/file-store/README.md

@@ -20,7 +20,7 @@
 
 ## Install
 
-In Node.js (16.0+), install with npm:
+In Node.js (20+), install with npm:
 
 ```bash
 npm install @tus/file-store
@@ -29,13 +29,13 @@ npm install @tus/file-store
 ## Use
 
 ```js
-const {Server} = require('@tus/server')
-const {FileStore} = require('@tus/file-store')
+const { Server } = require("@tus/server");
+const { FileStore } = require("@tus/file-store");
 
 const server = new Server({
-  path: '/files',
-  datastore: new FileStore({directory: './some/path'}),
-})
+  path: "/files",
+  datastore: new FileStore({ directory: "./some/path" }),
+});
 // ...
 ```
 
@@ -87,25 +87,25 @@ For demonstration purposes we will create a memory config store, but that's not
 idea. It's written in TypeScript.
 
 ```ts
-import type {Upload} from '@tus/server'
+import type { Upload } from "@tus/server";
 
 export class MemoryConfigstore {
-  data: Map<string, Upload> = new Map()
+  data: Map<string, Upload> = new Map();
 
   get(key: string): Upload | undefined {
-    return this.data.get(key)
+    return this.data.get(key);
   }
 
   set(key: string, value: Upload) {
-    this.data.set(key, value)
+    this.data.set(key, value);
   }
 
   delete(key: string) {
-    return this.data.delete(key)
+    return this.data.delete(key);
   }
 
   get list(): Record<string, Upload> {
-    return Object.fromEntries(this.data.entries())
+    return Object.fromEntries(this.data.entries());
   }
 }
 ```
@@ -124,7 +124,7 @@ This package is fully typed with TypeScript.
 
 ## Compatibility
 
-This package requires Node.js 16.0+.
+This package requires Node.js 20+.
 
 ## Contribute
 
@@ -138,14 +138,11 @@ See
 
 [extensions]: https://tus.io/protocols/resumable-upload.html#protocol-extensions
 [creation]: https://tus.io/protocols/resumable-upload.html#creation
-[creation with upload]:
-  https://tus.io/protocols/resumable-upload.html#creation-with-upload
+[creation with upload]: https://tus.io/protocols/resumable-upload.html#creation-with-upload
 [expiration]: https://tus.io/protocols/resumable-upload.html#expiration
 [checksum]: https://tus.io/protocols/resumable-upload.html#checksum
 [termination]: https://tus.io/protocols/resumable-upload.html#termination
 [concatenation]: https://tus.io/protocols/resumable-upload.html#concatenation
-[`cleanUpExpiredUploads`]:
-  https://github.com/tus/tus-node-server/tree/main/packages/server#cleanupexpireduploads
+[`cleanUpExpiredUploads`]: https://github.com/tus/tus-node-server/tree/main/packages/server#cleanupexpireduploads
 [kvstores]: https://github.com/tus/tus-node-server/tree/main/packages/server#kvstores
-[`KvStore`]:
-  https://github.com/tus/tus-node-server/blob/main/packages/utils/src/kvstores/Types.ts
+[`KvStore`]: https://github.com/tus/tus-node-server/blob/main/packages/utils/src/kvstores/Types.ts

packages/gcs-store/README.md

@@ -17,7 +17,7 @@
 
 ## Install
 
-In Node.js (16.0+), install with npm:
+In Node.js (20+), install with npm:
 
 ```bash
 npm install @tus/gcs-store
@@ -26,19 +26,19 @@ npm install @tus/gcs-store
 ## Use
 
 ```js
-const {Server} = require('@tus/server')
-const {GCSStore} = require('@tus/gcs-store')
+const { Server } = require("@tus/server");
+const { GCSStore } = require("@tus/gcs-store");
 
-const {Storage} = require('@google-cloud/storage')
+const { Storage } = require("@google-cloud/storage");
 
-const storage = new Storage({keyFilename: 'key.json'})
+const storage = new Storage({ keyFilename: "key.json" });
 
 const server = new Server({
-  path: '/files',
+  path: "/files",
   datastore: new GCSStore({
-    bucket: storage.bucket('tus-node-server-ci'),
+    bucket: storage.bucket("tus-node-server-ci"),
   }),
-})
+});
 // ...
 ```
 
@@ -74,7 +74,7 @@ This package is fully typed with TypeScript.
 
 ## Compatibility
 
-This package requires Node.js 16.0+.
+This package requires Node.js 20+.
 
 ## Contribute
 
@@ -88,8 +88,7 @@ See
 
 [extensions]: https://tus.io/protocols/resumable-upload.html#protocol-extensions
 [creation]: https://tus.io/protocols/resumable-upload.html#creation
-[creation with upload]:
-  https://tus.io/protocols/resumable-upload.html#creation-with-upload
+[creation with upload]: https://tus.io/protocols/resumable-upload.html#creation-with-upload
 [expiration]: https://tus.io/protocols/resumable-upload.html#expiration
 [checksum]: https://tus.io/protocols/resumable-upload.html#checksum
 [termination]: https://tus.io/protocols/resumable-upload.html#termination

packages/s3-store/README.md

@@ -22,7 +22,7 @@
 
 ## Install
 
-In Node.js (16.0+), install with npm:
+In Node.js (20+), install with npm:
 
 ```bash
 npm install @tus/s3-store
@@ -31,8 +31,8 @@ npm install @tus/s3-store
 ## Use
 
 ```js
-const {Server} = require('@tus/server')
-const {S3Store} = require('@tus/s3-store')
+const { Server } = require("@tus/server");
+const { S3Store } = require("@tus/s3-store");
 
 const s3Store = new S3Store({
   partSize: 8 * 1024 * 1024, // Each uploaded part will have ~8MiB,
@@ -44,8 +44,8 @@ const s3Store = new S3Store({
       secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
     },
   },
-})
-const server = new Server({path: '/files', datastore: s3Store})
+});
+const server = new Server({ path: "/files", datastore: s3Store });
 // ...
 ```
 
@@ -199,22 +199,22 @@ docs for the supported values of
 [credentials](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Credentials.html#constructor-property)
 
 ```js
-const aws = require('aws-sdk')
-const {Server} = require('@tus/server')
-const {S3Store} = require('@tus/s3-store')
+const aws = require("aws-sdk");
+const { Server } = require("@tus/server");
+const { S3Store } = require("@tus/s3-store");
 
 const s3Store = new S3Store({
   partSize: 8 * 1024 * 1024,
   s3ClientConfig: {
     bucket: process.env.AWS_BUCKET,
     region: process.env.AWS_REGION,
     credentials: new aws.ECSCredentials({
-      httpOptions: {timeout: 5000},
+      httpOptions: { timeout: 5000 },
       maxRetries: 10,
     }),
   },
-})
-const server = new Server({path: '/files', datastore: s3Store})
+});
+const server = new Server({ path: "/files", datastore: s3Store });
 // ...
 ```
 
@@ -231,7 +231,7 @@ const s3Store = new S3Store({
   partSize: 8 * 1024 * 1024,
   minPartSize: 8 * 1024 * 1024,
   // ...
-})
+});
 ```
 
 ### Example: use with Scaleway Object Storage
@@ -242,7 +242,7 @@ const s3Store = new S3Store({
 const s3Store = new S3Store({
   maxMultipartParts: 1000,
   // ...
-})
+});
 ```
 
 ## Types
@@ -251,7 +251,7 @@ This package is fully typed with TypeScript.
 
 ## Compatibility
 
-This package requires Node.js 16.0+.
+This package requires Node.js 20+.
 
 ## Contribute
 
@@ -265,16 +265,12 @@ See
 
 [extensions]: https://tus.io/protocols/resumable-upload.html#protocol-extensions
 [creation]: https://tus.io/protocols/resumable-upload.html#creation
-[creation with upload]:
-  https://tus.io/protocols/resumable-upload.html#creation-with-upload
+[creation with upload]: https://tus.io/protocols/resumable-upload.html#creation-with-upload
 [expiration]: https://tus.io/protocols/resumable-upload.html#expiration
 [checksum]: https://tus.io/protocols/resumable-upload.html#checksum
 [termination]: https://tus.io/protocols/resumable-upload.html#termination
 [concatenation]: https://tus.io/protocols/resumable-upload.html#concatenation
-[cleanExpiredUploads]:
-  https://github.com/tus/tus-node-server/tree/main/packages/server#servercleanupexpireduploads
-[lifecyle]:
-  https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html
+[cleanExpiredUploads]: https://github.com/tus/tus-node-server/tree/main/packages/server#servercleanupexpireduploads
+[lifecyle]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html
 [kvstores]: https://github.com/tus/tus-node-server/tree/main/packages/server#kvstores
-[`KvStore`]:
-  https://github.com/tus/tus-node-server/blob/main/packages/utils/src/kvstores/Types.ts
+[`KvStore`]: https://github.com/tus/tus-node-server/blob/main/packages/utils/src/kvstores/Types.ts