Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0xibra/robots-txt-component
Fully native robots.txt parsing component without any dependencies.
https://github.com/0xibra/robots-txt-component
nodejs robots-exclusion-standard robots-node robots-parser robots-txt robots-txt-node
Last synced: 5 days ago
JSON representation
Fully native robots.txt parsing component without any dependencies.
- Host: GitHub
- URL: https://github.com/0xibra/robots-txt-component
- Owner: 0xIbra
- License: mit
- Created: 2020-11-24T21:51:10.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-10-08T07:26:27.000Z (about 2 years ago)
- Last Synced: 2024-08-10T09:13:18.355Z (3 months ago)
- Topics: nodejs, robots-exclusion-standard, robots-node, robots-parser, robots-txt, robots-txt-node
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
robots-txt-component
====================
[](https://dl.circleci.com/status-badge/redirect/gh/ibra-akv/robots-txt-component/tree/master)
> Lightweight robots.txt parsing component **without any external dependencies** for **Node.js**.
Installation
------------
Via NPM
npm install robots-txt-component --save
Getting started
---------------
Before using the parser, you need to initialize it like below:
```js
const RobotsParser = require('robots-txt-component');
...
let robots = new RobotsParser('https://www.example.com', true) // allowOnNeutral = true
await robots.init() // Will attempt to retrieve the robots.txt file natively and parse it.
```
#### Check for allowance and other usages:
```js
let robots = new RobotsParser('https://www.example.com', true) // # allowOnNeutral = true
await robots.init() // # Will attempt to retrieve the robots.txt file natively and parse it.
userAgent = '*'
if (robots.canCrawl(url, userAgent)) { // # Will check the url against all the rules found in robots.txt file
// # Your logic
}
// # get the crawl delay for a user agent
let crawlDelay = robots.getCrawlDelay('Bingbot')
// # get raw robots.txt content
let content = robots.getRawContent()
```
API
---
### Robots
#### `constructor(url, allowOnNeutral = true, rawRobotsTxt = null)`
`url`: domain of which robots.txt file you want to use.
`allowOnNeutral`: if the same amount of allows and disallows exist for the a url, do we allow or disallow ?
`rawRobotsTxt`: if you already have retrieved the raw robots.txt content, provide it here.
#### `async init()`
**void**
Must be called and awaited before performing any other action.
This method attempts to retrieve the robots.txt file from the provided url.
#### `getRawContent()`
**string | null**
This method returns the raw robots.txt file content.
#### `canCrawl(url, userAgent)`
**boolean**
Checks the rules for the url path and the user agent in the robots.txt file and returns access policy.
#### `getCrawlDelay(userAgent)`
**integer**
Checks if `crawl-delay` is defined for the user agent and returns it if defined, if not, returns `0`.
LICENSE
-------
MIT License
Copyright (c) 2020 Ibragim Abubakarov
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.