Skip to content

kimulaco/amphtml-validator-extra

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

amphtml-validator-extra

Enhanced package of amphtml-validator.

It is possible to designate multiple URLs and file paths and verify them all together.

Use

const amphtmlValidator = require('amphtml-validator-extra');
const urls = [
    'https://example.com/article-01.html?amp',
    'https://example.com/article-02.html?amp',
    'https://example.com/article-03.html?amp'
];

amphtmlValidator.validateUrl(urls).then((result) => {
    console.log(result);
});
// [
//   status: 'PASS'
//   errors: [...]
// ],
// [
//   status: 'FAIL',
//   errors: [...]
// ],
// ...

Methods

validateHtml

amphtmlValidator.validateHtml('<html amp>...</html>').then((result) => {
    console.log(result);
});
Argment Type Description
html string AMP HTML sourde

validateUrl

let urls = [
    'https://example.com/article-01.html?amp',
    'https://example.com/article-02.html?amp',
    'https://example.com/article-03.html?amp'
];

amphtmlValidator.validateUrl(urls).then((result) => {
    console.log(result);
});
Argment Type Description
urls array or string AMP Page URL.
option.auth.user string Basic auth user name.
option.auth.password string Basic auth password.
option.progress function Progress callback function.

validateFile

let urls = [
    './test/article-01.html',
    './test/article-02.html',
    './test/article-03.html'
];

amphtmlValidator.validateFile(urls).then((result) => {
    console.log(result);
});
Argment Type Description
urls array or string AMP Page URL.
option.progress function Progress callback function.

Option

Progress callback function.

progress

let urls = [
    'https://example.com/article-01.html?amp',
    'https://example.com/article-02.html?amp',
    'https://example.com/article-03.html?amp'
];
let option = {
    progress: (progress) => {
        console.log(`${progress.index} / ${progress.max}`);
    }
};

amphtmlValidator.validateUrl(urls, option).then((result) => {
    console.log(result);
});
/*
 * 1 / 3
 * 2 / 3
 * 3 / 3
 */

auth

let urls = [
    'https://example.com/auth/article-01.html?amp',
    'https://example.com/auth/article-02.html?amp',
    'https://example.com/auth/article-03.html?amp'
];

amphtmlValidator.validateUrl(urls, {
    auth: {
        user: 'username',
        password: 'password'
    }
}).then((result) => {
    console.log(result);
});

Lisence

MIT Lisence

About

Enhanced package of amphtml-validator.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published