data-uri-to-buffer

What is data-uri-to-buffer?

The data-uri-to-buffer npm package is designed to convert Data URIs into Buffers. This is particularly useful when dealing with inline data within web applications, where you might need to handle the data as a binary stream for file operations, uploads, or other processing tasks.

What are data-uri-to-buffer's main functionalities?

Convert Data URI to Buffer

This feature allows you to convert a Data URI string into a Node.js Buffer. The resulting Buffer can then be used for various binary data operations.

const dataUriToBuffer = require('data-uri-to-buffer');
const dataUri = 'data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==';
const buffer = dataUriToBuffer(dataUri);
console.log(buffer.toString()); // 'Hello, World!'

0

README

data-uri-to-buffer

Create an ArrayBuffer instance from a Data URI string

This module accepts a "data" URI String of data, and returns an ArrayBuffer instance with the decoded data.

This module is intended to work on a large variety of JavaScript runtimes, including Node.js and web browsers.

Example

import { dataUriToBuffer } from 'data-uri-to-buffer';

// plain-text data is supported
let uri = 'data:,Hello%2C%20World!';
let parsed = dataUriToBuffer(uri);
console.log(new TextDecoder().decode(parsed.buffer));
// 'Hello, World!'

// base64-encoded data is supported
uri = 'data:text/plain;base64,SGVsbG8sIFdvcmxkIQ%3D%3D';
parsed = dataUriToBuffer(uri);
console.log(new TextDecoder().decode(parsed.buffer));
// 'Hello, World!'

API

export interface ParsedDataURI {
	type: string;
	typeFull: string;
	charset: string;
	buffer: ArrayBuffer;
}

dataUriToBuffer(uri: string | URL) → ParsedDataURI

The type property gets set to the main type portion of the "mediatype" portion of the "data" URI, or defaults to "text/plain" if not specified.

The typeFull property gets set to the entire "mediatype" portion of the "data" URI (including all parameters), or defaults to "text/plain;charset=US-ASCII" if not specified.

The charset property gets set to the Charset portion of the "mediatype" portion of the "data" URI, or defaults to "US-ASCII" if the entire type is not specified, or defaults to "" otherwise.

Note: If only the main type is specified but not the charset, e.g. "data:text/plain,abc", the charset is set to the empty string. The spec only defaults to US-ASCII as charset if the entire type is not specified.