@uppy/utils

What is @uppy/utils?

@uppy/utils is a utility library that provides a set of helper functions for working with files, URLs, and other common tasks in JavaScript. It is part of the Uppy file uploader ecosystem and is designed to simplify various operations related to file handling and manipulation.

What are @uppy/utils's main functionalities?

getFileNameAndExtension

This function extracts the file name and extension from a given file path or URL.

const { getFileNameAndExtension } = require('@uppy/utils');
const { name, extension } = getFileNameAndExtension('example.txt');
console.log(name); // 'example'
console.log(extension); // 'txt'

getSafeFileName

This function sanitizes a file name by replacing unsafe characters with safe ones.

const { getSafeFileName } = require('@uppy/utils');
const safeName = getSafeFileName('example file.txt');
console.log(safeName); // 'example-file.txt'

generateFileID

This function generates a unique ID for a file based on its properties such as name, type, and size.

const { generateFileID } = require('@uppy/utils');
const fileID = generateFileID({ name: 'example.txt', type: 'text/plain', size: 1024 });
console.log(fileID); // A unique file ID based on the file's properties

isPreviewSupported

This function checks if a given MIME type is supported for preview.

const { isPreviewSupported } = require('@uppy/utils');
const supported = isPreviewSupported('image/jpeg');
console.log(supported); // true

Other packages similar to @uppy/utils

file-type

The 'file-type' package is used to detect the file type of a Buffer/Uint8Array/ArrayBuffer. It is similar to @uppy/utils in that it helps with file handling, but it focuses specifically on detecting file types rather than providing a broader set of utilities.

mime

The 'mime' package is used to look up the MIME type of a file based on its extension. It is similar to @uppy/utils in that it deals with file types and extensions, but it does not provide the same range of utilities for file manipulation.

sanitize-filename

The 'sanitize-filename' package is used to sanitize file names by removing or replacing unsafe characters. It is similar to the getSafeFileName function in @uppy/utils, but it is focused solely on sanitizing file names.

README

@uppy/utils

Shared utility functions for Uppy Core and the “official” plugins maintained by the Uppy team.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Installation

Unless you are creating a custom plugin, you should not need to install this manually.

$ npm install @uppy/utils

License

The MIT License.

Changelog

4.0.3

Released: 2024-07-15

| Package | Version | Package | Version | | ---------------- | ------- | ---------------- | ------- | | @uppy/companion | 5.0.3 | @uppy/xhr-upload | 4.0.1 | | @uppy/locales | 4.0.2 | uppy | 4.0.3 |

• @uppy/companion: Improve error message when window.opener == null (Mikael Finstad / #5340)
• @uppy/xhr-upload: correctly type xhrUpload meta (Merlijn Vos / #5344)
• meta: fix require path in upload-to-cdn (Antoine du Hamel / #5343)