Commit 9691dc54 authored by Paul Colin Hennig's avatar Paul Colin Hennig
Browse files

Merge branch 'master' of git.y.gy:firstdorsal/powerdns-api

parents 3fad0c59 b219f420
......@@ -99,10 +99,10 @@ Feel free to contact me via [xl9jthv_7bvgakv9o9wg0jabn2ylm91xxrzzgt0e@y.gy](mail
* [powerdns-api](#module_powerdns-api)
* [.PowerdnsClient](#module_powerdns-api.PowerdnsClient)
* [new module.exports.PowerdnsClient(baseurl, apikey)](#new_module_powerdns-api.PowerdnsClient_new)
* [.getZone](#module_powerdns-api.PowerdnsClient+getZone)<code>object</code>
* [.getZones()](#module_powerdns-api.PowerdnsClient+getZones)<code>Array</code>
* [.createZone(zoneName, [kind])](#module_powerdns-api.PowerdnsClient+createZone)<code>Object</code>
* [.getZoneWithMeta(zoneName)](#module_powerdns-api.PowerdnsClient+getZoneWithMeta)<code>object</code>
* [.getZone(zoneName)](#module_powerdns-api.PowerdnsClient+getZone)<code>object</code>
* [.deleteZone(zoneName)](#module_powerdns-api.PowerdnsClient+deleteZone)<code>boolean</code>
* [.setHomogeneousRecords(records)](#module_powerdns-api.PowerdnsClient+setHomogeneousRecords)<code>boolean</code>
* [.deleteRecords(records)](#module_powerdns-api.PowerdnsClient+deleteRecords)<code>boolean</code>
......@@ -127,10 +127,10 @@ Class representing the powerdns client
* [.PowerdnsClient](#module_powerdns-api.PowerdnsClient)
* [new module.exports.PowerdnsClient(baseurl, apikey)](#new_module_powerdns-api.PowerdnsClient_new)
* [.getZone](#module_powerdns-api.PowerdnsClient+getZone)<code>object</code>
* [.getZones()](#module_powerdns-api.PowerdnsClient+getZones)<code>Array</code>
* [.createZone(zoneName, [kind])](#module_powerdns-api.PowerdnsClient+createZone)<code>Object</code>
* [.getZoneWithMeta(zoneName)](#module_powerdns-api.PowerdnsClient+getZoneWithMeta)<code>object</code>
* [.getZone(zoneName)](#module_powerdns-api.PowerdnsClient+getZone)<code>object</code>
* [.deleteZone(zoneName)](#module_powerdns-api.PowerdnsClient+deleteZone)<code>boolean</code>
* [.setHomogeneousRecords(records)](#module_powerdns-api.PowerdnsClient+setHomogeneousRecords)<code>boolean</code>
* [.deleteRecords(records)](#module_powerdns-api.PowerdnsClient+deleteRecords)<code>boolean</code>
......@@ -171,22 +171,6 @@ Create a powerdns client.
console.log(await pdns.getZone('example.com'));
})();
```
<a name="module_powerdns-api.PowerdnsClient+getZone"></a>
#### powerdnsClient.getZone ⇒ <code>object</code>
Returns array with rrsets for zone.
**Kind**: instance property of [<code>PowerdnsClient</code>](#module_powerdns-api.PowerdnsClient)
**Returns**: <code>object</code> - just the rrsets of the zone
| Param | Type | Description |
| --- | --- | --- |
| zoneName | <code>string</code> | takes a domain name |
**Example**
```js
await pdns.getZone('example.com');
```
<a name="module_powerdns-api.PowerdnsClient+getZones"></a>
#### powerdnsClient.getZones() ⇒ <code>Array</code>
......@@ -231,6 +215,22 @@ Returns single zone with meta information.
```js
await pdns.getZoneWithMeta('example.com');
```
<a name="module_powerdns-api.PowerdnsClient+getZone"></a>
#### powerdnsClient.getZone(zoneName) ⇒ <code>object</code>
Returns array with rrsets for zone.
**Kind**: instance method of [<code>PowerdnsClient</code>](#module_powerdns-api.PowerdnsClient)
**Returns**: <code>object</code> - just the rrsets of the zone
| Param | Type | Description |
| --- | --- | --- |
| zoneName | <code>string</code> | takes a domain name |
**Example**
```js
await pdns.getZone('example.com');
```
<a name="module_powerdns-api.PowerdnsClient+deleteZone"></a>
#### powerdnsClient.deleteZone(zoneName) ⇒ <code>boolean</code>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment