Nevertheless Published Mine
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

amp-api

1.0.2 • Public • Published

node-amp-api

node-amp-api is a node library that loads content into amp, updates amp cache, and validates urls against amp.

Contents

Installation

npm i amp-api --save --save-exact

Usage

Create an instance of AmpApi

const AmpApi = require('amp-api');
 
const ampApi = new AmpApi({
  // api key from google developer console
  apiKey: 'keyfromgooglecosole',
  // a logger that has info, warn, error, and fatal (defaults to console)
  log: logger, 
  // path on your file system to your private key
  keyPath: '/path-to/file-system/private-key.pem'
});

Validate a url, returns Promise

ampApi
  .validateAmpUrl(
    'https://fastcompany.com/40467645/how-pie-became-a-powerful-punchline-in-political-provocation'
  )

Batch Get Urls to Load in Amp, returns Promise

ampApi
      .batchGet({
        lookupStrategy: 'FETCH_LIVE_DOC',
        urls: [
          'https://amp.fastcompany.com/40491026/james-corden-lives-in-the-moment-heres-how'
        ]
      })

Update google's cache, returns Promise

ampApi
    .updateCache(
        'https://amp.fastcompany.com/40491026/james-corden-lives-in-the-moment-heres-how'
    )
 

Contributing

Open an issue.

Get an api key:

https://console.developers.google.com/apis/dashboard

Follow google's directions on hosting the public key:

https://developers.google.com/amp/cache/update-cache

Example here:

https://www.fastcompany.com/.well-known/amphtml/apikey.pub

Update local .env.

Code, test, make a PR, reference the issue.

install

npm i amp-api

Downloadsweekly downloads

4

version

1.0.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar