amphtml-validator-extra

Enhanced package of amphtml-validator.

0.1.6
latest
npm

Version published: 5 years ago

Maintainers: 1

Created: 6 years ago

Source

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

Keywords

FAQs

What is amphtml-validator-extra?

Is amphtml-validator-extra well maintained?

Package last updated on 08 Jun 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install