52 lines
2.5 KiB
Markdown
52 lines
2.5 KiB
Markdown
# cflare
|
|
easy cloudflare management
|
|
|
|
## Availabililty
|
|
[](https://www.npmjs.com/package/cflare)
|
|
[](https://GitLab.com/mojoio/cflare)
|
|
[](https://github.com/mojoio/cflare)
|
|
[](https://mojoio.gitlab.io/cflare/)
|
|
|
|
## Status for master
|
|
[](https://GitLab.com/mojoio/cflare/commits/master)
|
|
[](https://GitLab.com/mojoio/cflare/commits/master)
|
|
[](https://www.npmjs.com/package/cflare)
|
|
[](https://david-dm.org/mojoio/cflare)
|
|
[](https://www.bithound.io/github/mojoio/cflare/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/mojoio/cflare)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](http://standardjs.com/)
|
|
|
|
## Usage
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
```javascript
|
|
import * as cflare from 'cflare'
|
|
|
|
let myCflareAccount = new cflare.CflareAccount()
|
|
testCflareAccount.auth({
|
|
email: 'someuser@example.com',
|
|
key: 'someLongApiKey'
|
|
})
|
|
|
|
let myAsyncCflareManagement = async () => {
|
|
// get things
|
|
let myZones = await myCflareAccount.listZones() // zones are fully typed
|
|
let myIdForADomain = await myCflareAccount.getZoneId('example.com') // type number
|
|
let myRecordsForADomain = await myCflareAccount.listRecords('example.com') // records are fully typed
|
|
|
|
// set things
|
|
myCflareAccount.updateRecord(...)
|
|
myCflareAccount.createRecord(...)
|
|
myCflareAccount.deleteRecord(...)
|
|
}
|
|
|
|
```
|
|
|
|
For further information read the linked docs at the top of this README.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
|
|
[](https://mojo.io)
|