54 lines
3.1 KiB
Markdown
54 lines
3.1 KiB
Markdown
# @pushrocks/smartdns
|
|
smart dns methods written in TypeScript
|
|
|
|
## Availabililty and Links
|
|
* [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/)
|
|
|
|
## Status for master
|
|
|
|
Status Category | Status Badge
|
|
-- | --
|
|
GitLab Pipelines | [](https://lossless.cloud)
|
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
|
npm | [](https://lossless.cloud)
|
|
Snyk | [](https://lossless.cloud)
|
|
TypeScript Support | [](https://lossless.cloud)
|
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
Code Style | [](https://lossless.cloud)
|
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
|
|
|
## Usage
|
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
```typescript
|
|
const mySmartDns = new smartdns.SmartDns(); // uses Google DNS Https API
|
|
const demoRecord = await mySmartDns.getRecord('example.com', 'AAAA'); // returns promise
|
|
/*
|
|
demoRecord looks like this:
|
|
{
|
|
name: 'example.com',
|
|
type: 'A',
|
|
dnsSecEnabled: true,
|
|
value: '104.24.103.243'
|
|
}
|
|
*/
|
|
```
|
|
|
|
## Contribution
|
|
|
|
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). :)
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
|
|
[](https://maintainedby.lossless.com)
|