# opds-feed-parser

> OPDS feed parser

Latest version **0.1.0** (published 2024-07-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install opds-feed-parser
pnpm add opds-feed-parser
yarn add opds-feed-parser
bun add opds-feed-parser
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2024-07-17 |
| First published | 2016-01-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 144.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | NYPL |
| Maintainers | thespicemustflow, skomputer, aslagle, leonardr |

## Links

- npm: https://www.npmjs.com/package/opds-feed-parser
- Repository: https://github.com/NYPL-Simplified/opds-feed-parser
- Homepage: https://github.com/NYPL-Simplified/opds-feed-parser#readme
- Issues: https://github.com/NYPL-Simplified/opds-feed-parser/issues
- npm.io page: https://npm.io/package/opds-feed-parser

## Dependencies (1)

- [xml2js](https://npm.io/package/xml2js.md) 0.6.2

## Recent versions

- 0.1.0 (latest) — 2024-07-17
- 0.1.0-rc — 2024-07-15
- 0.0.18 — 2019-08-14
- 0.0.17 — 2019-07-03
- 0.0.16 — 2019-06-03
- 0.0.15 — 2018-10-16
- 0.0.14 — 2018-01-17
- 0.0.13 — 2016-08-22
- 0.0.12 — 2016-08-02
- 0.0.11 — 2016-05-11
- 0.0.10 — 2016-05-10
- 0.0.9 — 2016-02-17
- 0.0.8 — 2016-02-11
- 0.0.7 — 2016-02-04
- 0.0.6 — 2016-02-03
- … 5 more at https://npm.io/package/opds-feed-parser/versions

## README

# opds-feed-parser

Javascript OPDS feed parser. Covers [OPDS 1.1](http://opds-spec.org/specs/opds-catalog-1-1-20110627/).


## Usage

```sh
npm install opds-feed-parser
```

Example:
```js
var Parser = require("opds-feed-parser").default;
var request = require("request");

var parser = new Parser();
request("http://feedbooks.github.io/opds-test-catalog/catalog/acquisition/blocks.xml", (error, response, body) => {
    var promise = parser.parse(body);
    promise.then((result) => {
        console.dir(result);
    });
```

## Setup

Version `0.1.0` requires Node 20 or higher.

The previous working version, `0.0.18` can be used with Node version < 18.

It is recommended to use [`nvm`](https://github.com/nvm-sh/nvm) to install different versions of Node needed on your machine.


## License

```
Copyright © 2015 The New York Public Library, Astor, Lenox, and Tilden Foundations

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

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