@fazenda/mdnsearch
v1.0.0
Published
A NPM package that searches the Mozilla Developer Network website.
Downloads
2
Readme
MDNSearch
A NPM package that searches the Mozilla Developer Network website.
About
A simple way of searching MDN content. I just wrote this package to be more complete for what I need -- see what I mean in MDNSearchBot.
How to use it
- searchMDN ( { term: string | Array<string>; page?: number; locale?: string; topics?: string | Array<string>; })
- locale: remember that should be in the following format: "language-COUNTRY"
Example:
import { searchMDN } from 'MDNSearch';
searchMDN({ term: 'Array' }).then(console.log);
searchMDN({ term: 'Array', locale: 'pt-BR' }).then(console.log);
const searched = await searchMDN({ term: 'Array', page: 2 });
Testing
There's a Travis CI integration and I've written all the testing with Jest.
Code
Plain and simple Typescript and the Microsoft linter standards for it.
Contributing
Just talk to me through opening a issue.
Versioning
Just using plain and simple npm version. See the badge at the top of this readme.
TODO
Since I will be keeping this README up to date with any major change and I don't use any versioning system to log all the fixed bugs or previous projects updates, you can still have a taste of what comes next and what is being under analysis right in the Projects tab.
Authors
- Only me for now.
Consider buy me a coffee:
Or even becoming a patron:
License
Like many Open-Source Software (OSS) the MIT license is used, more about it in LICENSE.