docs.md

Sitemapper

src/assets/sitemapper.js:19-194

Parameters

• options

constructor

src/assets/sitemapper.js:32-37

Construct the Sitemapper class

Parameters

• options

Examples

let sitemap = new Sitemapper({
                                url: 'http://wp.seantburke.com/sitemap.xml',
                                timeout: 15000
                              });

fetch

src/assets/sitemapper.js:48-51

Gets the sites from a sitemap.xml with a given URL

Parameters

• url [string] the Sitemaps url (e.g http://wp.seantburke.com/sitemap.xml)

Examples

sitemapper.fetch('example.xml')
                   .then((sites) => console.log(sites));

Returns Promise<SitesData>

getSites

src/assets/sitemapper.js:188-193

Gets the sites from a sitemap.xml with a given URL

Parameters

• url (optional, default this.url)

timeout

src/assets/sitemapper.js:70-72

Set the timeout

Parameters

• duration Timeout

Examples

sitemapper.timeout = 15000; // 15 seconds

timeout

src/assets/sitemapper.js:59-61

Get the timeout

Examples

console.log(sitemapper.timeout);

Returns Timeout

url

src/assets/sitemapper.js:88-90

Get the url to parse

Examples

console.log(sitemapper.url)

Returns string

url

src/assets/sitemapper.js:79-81

Parameters

• url string url for making requests. Should be a link to a sitemaps.xml

Examples

sitemapper.url = 'http://wp.seantburke.com/sitemap.xml'

ParseData

src/assets/sitemapper.js:19-194

Resolve handler type for the promise in this.parse()

Properties

• error Error that either comes from xmlParse or request or custom error
• data Object
  • data.url string URL of sitemap
  • data.urlset Array Array of returned URLs
    • data.urlset.url string single Url
  • data.sitemapindex Object index of sitemap
    • data.sitemapindex.sitemap string Sitemap

Examples

{
       error: "There was an error!"
       data: {
         url: 'linkedin.com',
         urlset: [{
           url: 'www.linkedin.com/project1'
         },[{
           url: 'www.linkedin.com/project2'
         }]
       }
}

SitesArray

src/assets/sitemapper.js:19-194

An array of urls

Examples

[
           'www.google.com',
           'www.linkedin.com'
         ]

SitesData

src/assets/sitemapper.js:19-194

Resolve handler type for the promise in this.parse()

Properties

• url string the original url used to query the data
• sites SitesArray

Examples

{
         url: 'linkedin.com/sitemap.xml',
         sites: [
           'linkedin.com/project1',
           'linkedin.com/project2'
           ]

Timeout

src/assets/sitemapper.js:19-194

Timeout in milliseconds

xmlParse

src/assets/sitemapper.js:11-11

Sitemap Parser

Copyright (c) 2014 Sean Thomas Burke Licensed under the MIT license.