Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@tus/file-store
Advanced tools
@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.
In Node.js (16.0+), install with npm:
npm install @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'}),
})
// ...
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
.
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 | ❌ |
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}),
This package is fully typed with TypeScript.
This package requires Node.js 16.0+.
See
contributing.md
.
FAQs
Local file storage for @tus/server
The npm package @tus/file-store receives a total of 9,845 weekly downloads. As such, @tus/file-store popularity was classified as popular.
We found that @tus/file-store demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.