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.
@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 --save
License
The MIT License.
2.3.0
Released: 2021-12-07
| Package | Version | Package | Version |
| ------------------------- | ------- | ------------------------- | ------- |
| @uppy/angular | 0.2.6 | @uppy/locales | 2.0.4 |
| @uppy/audio | 0.2.0 | @uppy/onedrive | 2.0.5 |
| @uppy/aws-s3 | 2.0.6 | @uppy/provider-views | 2.0.6 |
| @uppy/aws-s3-multipart | 2.2.0 | @uppy/react | 2.1.2 |
| @uppy/box | 1.0.5 | @uppy/screen-capture | 2.0.5 |
| @uppy/companion | 3.1.2 | @uppy/status-bar | 2.1.2 |
| @uppy/companion-client | 2.0.4 | @uppy/store-default | 2.0.3 |
| @uppy/core | 2.1.3 | @uppy/thumbnail-generator | 2.0.6 |
| @uppy/dashboard | 2.1.2 | @uppy/transloadit | 2.0.5 |
| @uppy/drag-drop | 2.0.5 | @uppy/tus | 2.1.2 |
| @uppy/dropbox | 2.0.5 | @uppy/url | 2.0.5 |
| @uppy/facebook | 2.0.5 | @uppy/utils | 4.0.4 |
| @uppy/file-input | 2.0.5 | @uppy/webcam | 2.0.5 |
| @uppy/golden-retriever | 2.0.6 | @uppy/xhr-upload | 2.0.6 |
| @uppy/google-drive | 2.0.5 | @uppy/zoom | 1.0.5 |
| @uppy/image-editor | 1.1.0 | @uppy/robodog | 2.1.4 |
| @uppy/informer | 2.0.5 | uppy | 2.3.0 |
| @uppy/instagram | 2.0.5 | | |
- meta: add release automations (Antoine du Hamel / #3304)
- @uppy/dashboard: Save meta fields when opening the image editor (Merlijn Vos / #3339)
- @uppy/aws-s3-multipart: Drop
lockedCandidatesForBatch
and mark chunks as busy when preparing (Yegor Yarko / #3342) - @uppy/webcam: fix broken links in
webcam.md
(Antoine du Hamel / #3346) - @uppy/audio: new @uppy/audio plugin for recording with microphone (Artur Paikin / #2976)
- build: force use of
@babel/plugin-proposal-optional-chaining
(Antoine du Hamel / #3335) - @uppy/companion: fix deploy Yarn version (Antoine du Hamel / #3327)
- @uppy/companion: upgrade aws-sdk (Mikael Finstad / #3334)
- @uppy/core: disable loose transpilation for legacy bundle (Antoine du Hamel / #3329)
- @uppy/angular: examples: update
angular-example
to Angular v13 (Antoine du Hamel / #3325) - meta: Update BACKLOG.md (Artur Paikin, Merlijn Vos)
- meta: Add disableLocalFiles to options summary (Steve Barker / #3323)
- meta: Create SECURITY.md (Ziding Zhang / #3052)
- @uppy/image-editor: Pass croppedCanvasOptions to getCroppedCanvas (Mohamed Boudra / #3320)
- meta: finish
master
->main
job (Mikael Finstad / #3315) - website: update documents that were out of date (Antoine du Hamel / #3317)
- @uppy/status-bar: Status bar error state improvements (Merlijn Vos / #3299)
- doc: Fix typo in
docs/drag-drop.md
(Ash Allen / #3319) - website: Update /support and docs about Transloadit-hosted Companion (Artur Paikin / #3243)
- @uppy/aws-s3,@uppy/box,@uppy/core,@uppy/dashboard,@uppy/drag-drop,@uppy/dropbox,@uppy/facebook,@uppy/file-input,@uppy/google-drive,@uppy/image-editor,@uppy/instagram,@uppy/locales,@uppy/onedrive,@uppy/screen-capture,@uppy/status-bar,@uppy/thumbnail-generator,@uppy/transloadit,@uppy/url,@uppy/webcam,@uppy/xhr-upload,@uppy/zoom: Refactor locale scripts & generate types and docs (Merlijn Vos / #3276)
- @uppy/companion: Remove references of incorrect
options
argument for companion.socket
(Mikael Finstad / #3307) - @uppy/companion: Upgrade linting to 2.0.0-0 (Kevin van Zonneveld / #3280)