@tus/file-store

👉 Note: since 1.0.0 packages are split and published under the @tus scope. The old package, tus-node-server, is considered unstable and will only receive security fixes. Make sure to use the new packages.

Contents

• Install
• Use
• API
  • new FileStore(options)
• Extensions
• Examples
  • Example: creating your own config store
• Types
• Compatibility
• Contribute
• License

Install

In Node.js (16.0+), install with npm:

npm install @tus/file-store

Use

const {Server} = require('@tus/server')
const {FileStore} = require('@tus/file-store')

const server = new Server({
  path: '/files',
  datastore: new FileStore({directory: './some/path'}),
})
// ...

API

This package exports FileStore. There is no default export.

new FileStore(options)

Creates a new file store with options.

options.directory

The directory to store the files on disk (string).

options.configstore

Provide your own storage solution for the metadata of uploads (KvStore).

Default uses FileKvStore which puts the metadata file next to the uploaded file. See the exported KV stores from @tus/server for more information.

options.expirationPeriodInMilliseconds

The time before an ongoing upload is considered expired (number).

This is since the time of creation, not modification. Once an upload is considered expired, uploads can be removed with cleanUpExpiredUploads.

Extensions

The tus protocol supports optional extensions. Below is a table of the supported extensions in @tus/file-store.

| Extension | @tus/file-store | | ------------------------ | ----------------- | | Creation | ✅ | | Creation With Upload | ✅ | | Expiration | ✅ | | Checksum | ❌ | | Termination | ✅ | | Concatenation | ❌ |

Examples

Example: creating your own config store

For demonstration purposes we will create a memory config store, but that's not a good idea. It's written in TypeScript.

import type {Upload} from '@tus/server'

export class MemoryConfigstore {
  data: Map<string, Upload> = new Map()

  get(key: string): Upload | undefined {
    return this.data.get(key)
  }

  set(key: string, value: Upload) {
    this.data.set(key, value)
  }

  delete(key: string) {
    return this.data.delete(key)
  }

  get list(): Record<string, Upload> {
    return Object.fromEntries(this.data.entries())
  }
}

Then use it:

import {MemoryConfigstore} from './MemoryConfigstore'

const store = new FileStore({directory: './some/path', configstore: MemoryConfigstore}),

Types

This package is fully typed with TypeScript.

Compatibility

This package requires Node.js 16.0+.

Contribute

See contributing.md.

License

MIT © tus