tus-js-client/lib/index.test-d.ts

A pure JavaScript client for the tus resumable upload protocol

// This is a test file for ensuring that the type definitions in index.d.ts are
// working correctly. For more details see:
// https://github.com/SamVerschueren/tsd

import { expectType } from 'tsd'
import * as tus from '../'
import type { DetailedError } from '../'

expectType<boolean>(tus.isSupported)
expectType<boolean>(tus.canStoreURLs)

const file = new File(['foo'], 'foo.txt', {
  type: 'text/plain',
})

const upload = new tus.Upload(file, {
  endpoint: '',
  fingerprint: (file: File) => Promise.resolve(file.name),
  metadata: {
    filename: 'foo.txt',
  },
  metadataForPartialUploads: {
    userId: 'foo123bar',
  },
  onProgress: (bytesSent: number, bytesTotal: number) => {
    const percentage = ((bytesSent / bytesTotal) * 100).toFixed(2)
    console.log(bytesSent, bytesTotal, `${percentage}%`)
  },
  onChunkComplete: (_chunkSize: number, _bytesAccepted: number) => {},
  onSuccess: (payload: tus.OnSuccessPayload) => {
    console.log('Download from %s complete', upload.url)
    console.log('Response header', payload.lastResponse.getHeader('X-Info'))
  },
  onError: (error: Error | DetailedError) => {
    console.error(`Failed because: ${error}`)
  },
  headers: { TestHeader: 'TestValue' },
  chunkSize: 100,
  uploadUrl: '',
  uploadSize: 50,
  overridePatchMethod: true,
  retryDelays: [10, 20, 50],
  removeFingerprintOnSuccess: true,
  parallelUploads: 42,
  parallelUploadBoundaries: [
    { start: 0, end: 1 },
    { start: 1, end: 11 },
  ],
  onAfterResponse: (req: tus.HttpRequest, res: tus.HttpResponse) => {
    const url = req.getURL()
    const value = res.getHeader('X-My-Header')
    console.log(`Request for ${url} responded with ${value}`)
  },
})

upload.start()

upload.findPreviousUploads().then((uploads: tus.PreviousUpload[]) => {
  upload.resumeFromPreviousUpload(uploads[0])
})

upload.abort()
upload.abort(true).then(() => {})

const _upload2 = new tus.Upload(file, {
  endpoint: '',
})

// const reader = {
//     read: () => Promise.resolve({ done: true, value: '' }),
// };
// const upload3 = new tus.Upload(reader, {
//     endpoint: '',
//     uploadLengthDeferred: true,
// });

fetch('https://www.example.org')
  .then((response) => response.body)
  .then((rb) => {
    if (rb == null) {
      return
    }

    const reader = rb.getReader()
    return new tus.Upload(reader, {
      endpoint: '',
      uploadLengthDeferred: true,
    })
  })

tus.Upload.terminate('https://myurl.com', {
  endpoint: '',
})