https://github.com/dalenguyen/urls-checker
Get all urls from a page, then check whether all the urls is working or not.
https://github.com/dalenguyen/urls-checker
npm-package urls-checker webdevelopment
Last synced: 6 months ago
JSON representation
Get all urls from a page, then check whether all the urls is working or not.
- Host: GitHub
- URL: https://github.com/dalenguyen/urls-checker
- Owner: dalenguyen
- Created: 2018-11-14T17:50:47.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T05:21:52.000Z (almost 3 years ago)
- Last Synced: 2025-03-29T16:22:58.632Z (6 months ago)
- Topics: npm-package, urls-checker, webdevelopment
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/urls-checker
- Size: 123 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# URLs / Images Checker
[](https://badge.fury.io/js/urls-checker) [](https://travis-ci.org/dalenguyen/urls-checker)
Get all urls from a page - including images, then check whether all the urls is working or not.
## Getting started
```sh
npm install urls-checker
```
## Usage for Links
```javascript
const { urlsChecker } = require('urls-checker');
urlsChecker('https://example.com', 'main-domain' - optional) // http / https is important
.then(res => {
console.log(res);
})
.catch(err => console.log(err));
```
The result is an object of ok, fail and error urls
```sh
{
ok: ['list-of-working-urls'], // status code: 200
fail: [['url', 'status-code'], [...]], // status code will not be 200
error: [['url', 'message'], [...]], // Could be certificate / authenticate error
}
```
## Usage for Images
This method may not get all of the images because of the asynchronous loading.
```javascript
const { imagesChecker } = require('urls-checker');
imagesChecker('https://example.com', , 'main-domain' - optional) // http / https is important
.then(res => {
console.log(res);
})
.catch(err => console.log(err));
```
The result is an object of ok, fail and error urls
```sh
{
ok: ['list-of-working-urls'], // status code: 200
fail: [['url', 'status-code'], [...]], // status code will not be 200
error: [['url', 'message'], [...]], // Could be certificate / authenticate error
}
```
## Note
* The maximum number of links that this package can check is 400.
* The second parameter - 'main-domain' - is OPTIONAL. Because when you check a page http://example.com/bla-bla-bla, you will need a base domain to get the absolute URL of images or relative paths inside your page.
## Urls Checker for the whole website
We could get all pages from sitemap.xml, then loops through all the links. You should have a sitemap.xml on your website for SEO purposes.
## Contributions
This project is based on [urls-checker](https://github.com/dalenguyen/urls-checker), feel free to report bugs and make feature requests in the [Issue Tracker](https://github.com/dalenguyen/urls-checker/issues), fork and create pull requests!