@uppy/utils
Advanced tools
Shared utility functions for Uppy Core and plugins maintained by the Uppy team.
@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.
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 propertiesisPreviewSupported
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); // trueThe '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.
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.
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.
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.
Unless you are creating a custom plugin, you should not need to install this manually.
$ npm install @uppy/utils --save
0.28.0
| Package | Version | Package | Version | |-|-|-|-| | uppy | 0.28.0 | @uppy/xhr-upload | 0.28.0 | | @uppy/core | 0.28.0 | @uppy/react | 0.28.0 | | @uppy/dashboard | 0.28.0 | @uppy/transloadit | 0.28.0 | | @uppy/dropbox | 0.28.0 | @uppy/tus | 0.28.0 | | @uppy/form | 0.28.0 | @uppy/url | 0.28.0 | | @uppy/informer | 0.28.0 | @uppy/webcam | 0.28.0 | | @uppy/utils | 0.28.0 | @uppy/url | 0.28.0 | | @uppy/thumbnail-generator | 0.28.0 | @uppy/status-bar | 0.28.0 | | @uppy/redux-dev-tools | 0.28.0 | @uppy/react | 0.28.0 | | @uppy/provider-views | 0.28.0 | @uppy/progress-bar | 0.28.0 | | @uppy/instagram | 0.28.0 | @uppy/informer | 0.28.0 | | @uppy/google-drive | 0.28.0 | @uppy/golden-retriever | 0.28.0 | | @uppy/form | 0.28.0 | @uppy/file-input | 0.28.0 | | @uppy/dropbox | 0.28.0 | @uppy/drag-drop | 0.28.0 | | @uppy/dashboard | 0.28.0 | @uppy/companion | 0.15.0 | | @uppy/aws-s3 | 0.28.0 | @uppy/aws-s3-multipart | 0.28.0 |
allowMultipleUploads option to @uppy/core. If set to false, uppy.upload() can only be called once. Afterward, no new files can be added and no new uploads can be started. This is intended to serve the <form>-like use case. (#1064 / @goto-bus-stop)closeAfterFinish: true (#1106 / @goto-bus-stop)hideAllPanels after a file is added in Dashboard, instead of toggleAddFilesPanel(false) that didn’t hide some panelsCOMPANION_PATTERN constant (#1104 / @goto-bus-stop)FAQs
Shared utility functions for Uppy Core and plugins maintained by the Uppy team.
The npm package @uppy/utils receives a total of 223,324 weekly downloads. As such, @uppy/utils popularity was classified as popular.
We found that @uppy/utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 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
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.