valid-data-url

What is valid-data-url?

The valid-data-url npm package is a utility for validating whether a given string is a valid data URL. Data URLs are used to embed small files inline in documents.

What are valid-data-url's main functionalities?

Validate Data URL

This feature allows you to check if a given string is a valid data URL. The code sample demonstrates how to use the valid-data-url package to validate a base64 encoded data URL.

const validDataUrl = require('valid-data-url');

const url = 'data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==';
const isValid = validDataUrl(url);
console.log(isValid); // true

Other packages similar to valid-data-url

data-uri-to-buffer

The data-uri-to-buffer package converts a Data URI to a Buffer. While it does not directly validate data URLs, it can be used to parse and handle data URLs, which can be useful in conjunction with validation.

dataurl

The dataurl package provides utilities for parsing and serializing data URLs. It offers more comprehensive functionality compared to valid-data-url, including the ability to extract and manipulate the content of data URLs.

is-data-uri

The is-data-uri package is another utility for checking if a string is a valid data URI. It offers similar functionality to valid-data-url but may have different performance characteristics or additional features.

README

Detect if a string is a data URL

Based on Brian Grinstead's solution https://gist.github.com/bgrins/6194623. Special thanks to Jamie Davis for helping to fix ReDoS exploit.

Syntax

The "data" URL scheme is described here RFC2397

dataurl    := "data:" [ mediatype ] [ ";base64" ] "," data
mediatype  := [ type "/" subtype ] *( ";" parameter )
data       := *urlchar
parameter  := attribute "=" value

where urlchar is imported from RFC2396, and type, subtype, attribute and value are the corresponding tokens from RFC2045, represented using URL escaped encoding of RFC2396 as necessary.

Attribute values in RFC2045 are allowed to be either represented as tokens or as quoted strings. However, within a data URL, the quoted-string representation would be awkward, since the quote mark is itself not a valid urlchar. For this reason, parameter values should use the URL Escaped encoding instead of quoted string if the parameter values contain any tspecial.

The ;base64 extension is distinguishable from a content-type parameter by the fact that it doesn't have a following = sign.

Install

npm install valid-data-url

Example

'use strict';

var validDataUrl = require('valid-data-url');
var isValid = validDataUrl('data:text/plain;base64,SGVsbG8sIFdvcmxkIQ%3D%3D'); // true

People

The original author is Brian Grinstead

Contributors

• Gary Guagliardo Jr
• Steve Powell
• Rob Garrison
• Frank Tan
• Jamie Davis
• Bogdan Chadkin
• Jon Ursenbach

Licence

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Changelog

5.0.0 (2023-08-08)

• build: move from Travis CI to GitHub Actions
• docs: update badges
• chore: bump deps
• drops support for Node less than 14

<a name="4.0.1"></a>