Returns true if crawling the specified URL is allowed for the specified user-agent.
This will return undefined if the URL isn't valid for this robots.txt.
isDisallowed(url, [ua])
boolean or undefined
Returns true if crawling the specified URL is not allowed for the specified user-agent.
This will return undefined if the URL isn't valid for this robots.txt.
getMatchingLineNumber(url, [ua])
number or undefined
Returns the line number of the matching directive for the specified URL and user-agent if any.
Line numbers start at 1 and go up (1-based indexing).
Returns -1 if there is no matching directive. If a rule is manually added without a lineNumber then this will return undefined for that rule.
getCrawlDelay([ua])
number or undefined
Returns the number of seconds the specified user-agent should wait between requests.
Returns undefined if no crawl delay has been specified for this user-agent.
getSitemaps()
array
Returns an array of sitemap URLs specified by the sitemap: directive.
getPreferredHost()
string or null
Returns the preferred host name specified by the host: directive or null if there isn't one.
Changes
Version 3.0.1
Fixed bug with https: URLs defaulting to port 80 instead of 443 if no port is specified.
Thanks to @dskvr for reporting
This affects comparing URLs with the default HTTPs port to URLs without it.
For example, comparing https://example.com/ to https://example.com:443/ or vice versa.
They should be treated as equivalent but weren't due to the incorrect port
being used for https:.
Version 3.0.0
Changed to using global URL object instead of importing. – Thanks to @brendankenny
Version 2.4.0:
Added Typescript definitions
– Thanks to @danhab99 for creating
Added SECURITY.md policy and CodeQL scanning
Version 2.3.0:
Fixed bug where if the user-agent passed to isAllowed() / isDisallowed() is called "constructor" it would throw an error.
Added support for relative URLs. This does not affect the default behavior so can safely be upgraded.
Relative matching is only allowed if both the robots.txt URL and the URLs being checked are relative.
Fixed bug that with matching wildcard patterns with some URLs
– Thanks to @ckylape for reporting and fixing
Changed matching algorithm to match Google's implementation in google/robotstxt
Changed order of precedence to match current spec
Version 2.1.1:
Fix bug that could be used to causing rule checking to take a long time
– Thanks to @andeanfog
Version 2.1.0:
Removed use of punycode module API's as new URL API handles it
Improved test coverage
Added tests for percent encoded paths and improved support
Added getMatchingLineNumber() method
Fixed bug with comments on same line as directive
Version 2.0.0:
This release is not 100% backwards compatible as it now uses the new URL APIs which are not supported in Node < 7.
Update code to not use deprecated URL module API's.
– Thanks to @kdzwinel
Version 1.0.2:
Fixed error caused by invalid URLs missing the protocol.
Version 1.0.1:
Fixed bug with the "user-agent" rule being treated as case sensitive.
– Thanks to @brendonboshell
Improved test coverage.
– Thanks to @schornio
Version 1.0.0:
Initial release.
License
The MIT License (MIT)Copyright (c) 2014 Sam ClarkePermission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included inall copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, 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 INTHE SOFTWARE.