2020-02-15 16:46:04 +00:00
# @pushrocks/smartdns
smart dns methods written in TypeScript
2018-05-13 13:51:04 +00:00
2020-02-15 16:41:37 +00:00
## Availabililty and Links
2020-02-15 16:46:04 +00:00
* [npmjs.org (npm package) ](https://www.npmjs.com/package/@pushrocks/smartdns )
* [gitlab.com (source) ](https://gitlab.com/pushrocks/smartdns )
* [github.com (source mirror) ](https://github.com/pushrocks/smartdns )
* [docs (typedoc) ](https://pushrocks.gitlab.io/smartdns/ )
2017-07-18 13:45:06 +00:00
## Status for master
2020-02-15 16:46:04 +00:00
[![pipeline status ](https://gitlab.com/pushrocks/smartdns/badges/master/pipeline.svg )](https://gitlab.com/pushrocks/smartdns/commits/master)
[![coverage report ](https://gitlab.com/pushrocks/smartdns/badges/master/coverage.svg )](https://gitlab.com/pushrocks/smartdns/commits/master)
[![npm downloads per month ](https://img.shields.io/npm/dm/@pushrocks/smartdns.svg )](https://www.npmjs.com/package/@pushrocks/smartdns)
[![Known Vulnerabilities ](https://snyk.io/test/npm/@pushrocks/smartdns/badge.svg )](https://snyk.io/test/npm/@pushrocks/smartdns)
2020-02-15 16:41:37 +00:00
[![TypeScript ](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg )](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node ](https://img.shields.io/badge/node->=%2010.x.x-blue.svg )](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide ](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg )](https://prettier.io/)
2017-07-18 13:45:06 +00:00
## Usage
2018-05-13 13:51:04 +00:00
2017-07-18 13:45:06 +00:00
Use TypeScript for best in class instellisense.
2018-05-13 14:21:15 +00:00
```typescript
2020-02-15 16:41:37 +00:00
const mySmartDns = new smartdns.SmartDns(); // uses Google DNS Https API
2020-02-15 16:46:04 +00:00
const demoRecord = mySmartDns.getRecord('example.com', 'AAAA'); // returns promise
2020-02-15 16:41:37 +00:00
/*
demoRecord looks like this:
{
name: 'example.com',
type: 'A',
dnsSecEnabled: true,
value: '104.24.103.243'
}
*/
2018-05-13 14:21:15 +00:00
```
2020-02-15 16:46:04 +00:00
## Contribution
2017-07-18 13:45:06 +00:00
2020-02-15 16:46:04 +00:00
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time ](https://lossless.link/contribute-onetime ) or [contribute monthly ](https://lossless.link/contribute ). :)
2020-02-15 16:41:37 +00:00
For further information read the linked docs at the top of this readme.
2020-02-15 16:46:04 +00:00
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
2020-02-15 16:41:37 +00:00
| By using this npm module you agree to our [privacy policy ](https://lossless.gmbH/privacy )
[![repo-footer ](https://lossless.gitlab.io/publicrelations/repofooter.svg )](https://maintainedby.lossless.com)