attr-accept

What is attr-accept?

The attr-accept package is designed to provide functionality for checking if a file meets certain criteria specified through file attributes. This is particularly useful in scenarios where file uploads need to be validated based on file type, name, or other attributes before being processed or accepted. It's commonly used in web development projects to enhance the file upload feature by filtering out unacceptable files based on their attributes.

What are attr-accept's main functionalities?

File Type Validation

This feature allows developers to validate the type of the file by specifying a MIME type pattern. In the code sample, the function `accepts` is used to check if a file named 'example.jpg' with the MIME type 'image/jpeg' matches the specified pattern 'image/*'. This is useful for ensuring that only files of a certain type are processed.

const accepts = require('attr-accept');

const file = {
  name: 'example.jpg',
  type: 'image/jpeg'
};

const accepted = accepts(file, 'image/*');
console.log(accepted); // true or false

File Extension Validation

This feature enables the validation of files based on their extension. The provided code demonstrates how to use the `accepts` function to verify if a file with the name 'example.pdf' and the type 'application/pdf' has a '.pdf' extension. This can be particularly useful for applications that only need to accept files with specific extensions.

const accepts = require('attr-accept');

const file = {
  name: 'example.pdf',
  type: 'application/pdf'
};

const accepted = accepts(file, '.pdf');
console.log(accepted); // true or false

Other packages similar to attr-accept

file-type

The 'file-type' package is used to detect the file type of a Buffer/Uint8Array/ArrayBuffer. Unlike attr-accept, which matches files based on patterns or extensions provided by the developer, 'file-type' inspects the file content to determine its MIME type. This can be more reliable in cases where file extensions are incorrect or missing.

mime-types

The 'mime-types' package allows for the lookup of MIME types based on file extensions and vice versa. While attr-accept is used for validating files against specific patterns or extensions, 'mime-types' is more focused on the association between file extensions and their corresponding MIME types, providing a way to retrieve one from the other.

README

attr-accept

JavaScript implementation of the "accept" attribute for HTML5 <input type="file">

See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#attr-accept for more information.

Installation

npm install --save attr-accept

Usage

var accept = require('attr-accept');
accept({
    name: 'my file.png',
    type: 'image/png'
}, 'image/*') // => true

accept({
    name: 'my file.json',
    type: 'application/json'
}, 'image/*') // => false

accept({
    name: 'my file.srt',
    type: ''
}, '.srt') // => true

You can also pass multiple mime types as a comma delimited string or array.

accept({
    name: 'my file.json',
    type: 'application/json'
}, 'application/json,video/*') // => true

accept({
    name: 'my file.json',
    type: 'application/json'
}, ['application/json', 'video/*']) // => true

Contributing

Checkout the organization CONTRIBUTING.md.