dataurl

Tools for dealing with DataURLs

npm install dataurl
11 downloads in the last day
95 downloads in the last week
467 downloads in the last month

dataurl Build Status

Install

$ npm install dataurl

Usage

dataurl.parse(string)

Parses a dataurl string. Returns an object with three properties:

  • data : unencoded data
  • mimetype : mimetype of the data, something like 'image/png'
  • charset : charset of the data, if specified

If the input string isn't a valid dataURL, returns false.

dataurl.stream(options)

Creates a Read/Write Stream for encoding data as a DataURL.

Options expects up to three properties:

  • mimetype : Required
  • charset : Optional
  • encoded : Optional

Resulting stream will emit a data event for the header, then emit 'data' events for each chunk (base64 encoded, if necessary) as they pass through.

Example:

fs.createReadStream(pathToSomeImage).pipe(
  dataurl.stream({ mimetype: 'image/png'})
).pipe(process.stderr, {end: false});

dataurl.format(options)
dataurl.convert(options)

Converts some data to a dataurl string. Options expects up to four properties

  • data : Required
  • mimetype : Required
  • charset : Optional
  • encoded : Optional, whether to base64 encode the data. Defaults to true

License

MIT

Copyright (c) 2013 Brian J. Brennan

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.
npm loves you