# xmp-reader

> Extracts basic XMP/RDF metadata from JPEG files

Latest version **0.0.3** (published 2016-11-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install xmp-reader
pnpm add xmp-reader
yarn add xmp-reader
bun add xmp-reader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2016-11-09 |
| First published | 2016-11-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.3.2 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Alexander Kuznetsov |
| Maintainers | shkuznetsov |
| Keywords | jpeg, jpg, xmp, rdf, picasa, metadata |

## Links

- npm: https://www.npmjs.com/package/xmp-reader
- Repository: https://github.com/shkuznetsov/xmp-reader
- Issues: https://github.com/shkuznetsov/xmp-reader/issues
- npm.io page: https://npm.io/package/xmp-reader

## Dependencies (1)

- [sax](https://npm.io/package/sax.md) ^1.2.1

## Recent versions

- 0.0.3 (latest) — 2016-11-09
- 0.0.2 — 2016-11-09
- 0.0.1 — 2016-11-08

## README

# xmp-reader  [![NPM version](https://badge.fury.io/js/xmp-reader.svg)](http://badge.fury.io/js/xmp-reader) [![Build Status](https://travis-ci.org/shkuznetsov/xmp-reader.svg?branch=master)](https://travis-ci.org/shkuznetsov/xmp-reader)
Extracts some commonly used XMP/RDF metadata tags from JPEG files.
Does not pretend to be a complete metadata management tool, but allows you to extract some information other EXIF-management tools on NPM fail to retrieve.
Was originally created only to extract a Description field baked into my JPEGs by Google's Picasa.

## Usage

To install the module add it to your project's ``package.json`` dependencies or install manually running:
```
npm install xmp-reader
```

Then pull it in your code:
```javascript
const xmpReader = require('xmp-reader');
```

Now you can either feed it a file name:
```javascript
xmpReader.fromFile('/path/to/file.jpg', (err, data) => {
  if (err) console.log(err);
  else console.log(data);
});
```

Or a buffer:
```javascript
xmpReader.fromBuffer(buffer, (err, data) => {
  if (err) console.log(err);
  else console.log(data);
});
```

Both methods above return a promise, you can use that instead of the ``callback``:
```javascript
xmpReader.fromBuffer(buffer).then(
  (data) => console.log(data),
  (err) => console.log(err)
);
```

Output will look something like that, depending on your metadata:
```javascript
{
	"raw": {
		"MicrosoftPhoto:Rating": "50",
		"dc:title": "Title",
		"dc:description": "Title",
		"dc:creator": "Alexander Kuznetsov",
		"Iptc4xmpCore:Location": "New York",
		"MicrosoftPhoto:LastKeywordXMP": ["tag1", "tag2"],
		"MicrosoftPhoto:LastKeywordIPTC": ["tag1", "tag2"],
		"xmp:Rating": "3"
	},
	"rating": 3,
	"title": "Title",
	"description": "Title",
	"creator": "Alexander Kuznetsov",
	"location": "New York",
	"keywords": ["tag1", "tag2"]
}
```
``raw`` property contains vendor-specific tag names.

## License
[MIT License](http://en.wikipedia.org/wiki/MIT_License)

---
_Source: https://npm.io/package/xmp-reader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._