# rss-finder

> Find rss feeds url

Latest version **2.1.5** (published 2020-12-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install rss-finder
pnpm add rss-finder
yarn add rss-finder
bun add rss-finder
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.5 |
| Published | 2020-12-30 |
| First published | 2015-12-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 9.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 73 |
| Author | Gergely Kovács |
| Maintainers | ggkovacs |
| Keywords | rss, find, feeds, atom, rdf |

## Links

- npm: https://www.npmjs.com/package/rss-finder
- Repository: https://github.com/ggkovacs/rss-finder
- Issues: https://github.com/ggkovacs/rss-finder/issues
- npm.io page: https://npm.io/package/rss-finder

## Dependencies (5)

- [got](https://npm.io/package/got.md) ^11.8.1
- [extend](https://npm.io/package/extend.md) ^3.0.2
- [feedparser](https://npm.io/package/feedparser.md) ^2.2.9
- [htmlparser2](https://npm.io/package/htmlparser2.md) ^6.0.0
- [pinkie-promise](https://npm.io/package/pinkie-promise.md) ^2.0.1

## Recent versions

- 2.1.5 (latest) — 2020-12-30
- 2.1.4 — 2020-05-27
- 2.1.3 — 2019-12-09
- 2.1.2 — 2019-07-25
- 2.1.1 — 2019-06-23
- 2.1.0 — 2019-01-22
- 2.0.6 — 2018-07-28
- 2.0.5 — 2018-03-16
- 2.0.4 — 2017-06-29
- 2.0.3 — 2017-03-14
- 2.0.2 — 2016-12-26
- 2.0.1 — 2016-11-14
- 2.0.0 — 2016-07-13
- 1.0.3 — 2016-05-01
- 1.0.2 — 2016-04-03
- … 3 more at https://npm.io/package/rss-finder/versions

## README

# RSS Finder [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status][coverage-image]][coverage-url]
Version: **2.1.5**

## Installation

Run `npm install rss-finder`

## Usage

```js
'use strict';

var rssFinder = require('rss-finder');

rssFinder('http://www.nytimes.com').then(function(res) {
    console.log(res);
}).catch(function(err) {
    console.log(err);
});

// or

rssFinder({
    url: 'http://www.nytimes.com'
}).then(function(res) {
    console.log(res);
}).catch(function(err) {
    console.log(err);
});
```

### Response
```js
{
    site: {
        title: 'The New York Times - Breaking News, World News & Multimedia',
        favicon: 'http://static01.nyt.com/favicon.ico',
        url: 'http://www.nytimes.com'
    },
    feedUrls:[{
        title: 'RSS',
        url: 'http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml'
    }]
}
```

## API

### rssFinder(options)

#### options
Type: `String` | `Object`

##### url
Type: `String`

##### gotOptions

This object is passed to [`got` options](https://github.com/sindresorhus/got#api) directly (refer to [`got` documentation](https://github.com/sindresorhus/got)).

##### feedParserOptions

This object is passed to [`feedparser` options](https://github.com/danmactough/node-feedparser#options) directly (refer to [`feedparser` documentation](https://github.com/danmactough/node-feedparser)).


# License
MIT © 2020 Gergely Kovács (gg.kovacs@gmail.com)

[npm-image]: https://badge.fury.io/js/rss-finder.svg
[npm-url]: https://npmjs.org/package/rss-finder
[travis-image]: https://travis-ci.com/ggkovacs/rss-finder.svg?branch=master
[travis-url]: https://travis-ci.com/ggkovacs/rss-finder
[daviddm-image]: https://david-dm.org/ggkovacs/rss-finder.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/ggkovacs/rss-finder
[coverage-image]: https://coveralls.io/repos/ggkovacs/rss-finder/badge.svg?service=github&branch=master
[coverage-url]: https://coveralls.io/github/ggkovacs/rss-finder?branch=master

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