README.md

Mdn-docs-search

A small package made to search the mdn docs

Usage

Example:

const MDNDocs = require('mdn-docs-search');

// Create an async function for resolving the result
async function searchDocs() {
  const result = await MDNDocs.search('Map.prototype.delete'); // Search the docs
  const docs = await MDNDocs.load(result); // Load the url from searching the docs
  return docs.name; // get the name
}

await searchDocs(); // Use the function

Properties

• name - Name of the page
• description - Description of the page, markdown support included
• url - Url of the page
• examples - Examples section of the page, if any
• polyfill - Polyfill section of the page, if any
• syntax - Syntax section of the page, if any
• params - Parameters section of the page, parameters sorted and markdown support included
• pageDescription - Description section of the page, if any, markdown support included
• seeAlso - See also section of the page, if any, markdown support included
• methods - Methods section of the page, if any
• returnValue - Return value of the page, if any

Contributing

If you want to contribute with anything please open a pull request