mtup v0.0.2

Upload Service

This is a configurable file upload service written in TypeScript. It provides flexible options for file uploading, including support for multiple file uploads, custom upload handlers, and configurable retry limits.

Features

• Configurable File Uploads: Accepts various file types and supports multiple file uploads.
• Retry Mechanism: Allows setting maximum retry attempts for failed uploads.
• Custom Upload Handling: Supports custom upload logic through a user-defined function.
• Timeout Control: Configurable upload timeout to handle slow network conditions.
• File Size Validation: Enforces a maximum file size limit for uploads.

Installation

To use this upload service, install it via npm:

npm install upload-service

Usage

Basic Example

import { UploadService, UploadConfig } from 'upload-service';

const config: UploadConfig = {
  accept: 'image/*',
  multiple: true,
  maxRetries: 3,
  timeout: 10000, // 10 seconds
  maxSize: 5 * 1024 * 1024, // 5 MB
};

const uploadService = new UploadService(config);

const fileInput = document.querySelector('input[type="file"]');
if (fileInput) {
  fileInput.addEventListener('change', async () => {
    if (fileInput.files) {
      try {
        await uploadService.uploadFiles(Array.from(fileInput.files));
        console.log('Upload successful');
      } catch (error) {
        console.error('Upload failed:', error);
      }
    }
  });
}

Custom Uploader Example

import { UploadService, UploadConfig, UploadOptions } from 'upload-service';

const customUploader = async (file: File, uploadOptions: UploadOptions) => {
  console.log(`Uploading file: ${file.name}`);
  // Custom upload logic here (e.g., using fetch or Axios)
  await new Promise((resolve) => setTimeout(resolve, 1000)); // Simulate async upload
  console.log(`File uploaded: ${file.name}`);
};

const config: UploadConfig = {
  customUploader,
};

const uploadService = new UploadService(config);

Configuration Options

UploadConfig

Development

Prerequisites

• Node.js
• npm or Yarn

Building the Project

To build the project, run:

npm run build

Running Tests

To run the test suite, use:

npm test

Contributing

Contributions are welcome! Please submit a pull request or open an issue to suggest changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.