A JavaScript wrapper for the Now API
JavaScript
Latest commit b8868db Jan 8, 2017 @timolins timolins committed on GitHub 1.0 (#55)
* use ava instead of mocha

closes zeit/now-client#46

* Remove callback support

* Switch to ES6 Class & remove comments
Permalink
Failed to load latest commit information.
src 1.0 (#55) Jan 8, 2017
test 1.0 (#55) Jan 8, 2017
.gitignore People already have this ignored globally Sep 21, 2016
.travis.yml Only test on latest node Oct 12, 2016
README.md 1.0 (#55) Jan 8, 2017
gulpfile.babel.js Added gulpfile Oct 30, 2016
package.json 1.0 (#55) Jan 8, 2017

README.md

𝚫 now client

Build Status XO code style

Node.js module to interact with the official 𝚫 now API.

You need to provide your API token, which you can obtain here. It is possible to pass it as a parameter or with the NOW_TOKEN environment variable. When no token is given, it will use the one contained in your ~/.now.json file.

$ npm install --save now-client

Examples

Here are a few snippets on how to use this package in your project:

ES2015

import nowClient from 'now-client'

const now = nowClient('YOUR TOKEN')

let deployments

try {
  deployments = await now.getDeployments()
} catch (err) {
  console.error(err)
}

console.log(deployments)

Older ES

const nowClient = require('now-client')
const now = nowClient('YOUR TOKEN')

now.getDeployments().then(deployments => {
  console.log(deployments)
}).catch(err => {
  console.error(err)
})

API Reference

Kind: global class

new Now([token])

Initializes the API. Looks for token in ~/.now.json if none is provided.

Param Type Description
[token] String Your now API token.

now.getDeployments([callback]) β‡’ Promise

Returns an array with all deployments.

Kind: instance method of Now
See: https://zeit.co/api#list-endpoint

Param Type Description
[callback] function Callback will be called with (err, deployments)

now.getDeployment(id, [callback]) β‡’ Promise

Returns an object with deployment data.

Kind: instance method of Now
See: https://zeit.co/api#get-endpoint

Param Type Description
id String ID of deployment
[callback] function Callback will be called with (err, deployment)

now.createDeployment(body, [callback]) β‡’ Promise

Creates a new deployment and returns its data.

Kind: instance method of Now
See: https://zeit.co/api#instant-endpoint

Param Type Description
body Object The keys should represent a file path, with their respective values containing the file contents.
[callback] function Callback will be called with (err, deployment)

now.deleteDeployment(id, [callback]) β‡’ Promise

Deletes a deployment and returns its data.

Kind: instance method of Now
See: https://zeit.co/api#rm-endpoint

Param Type Description
id String ID of deployment
[callback] function Callback will be called with (err, deployment)

now.getFiles(id, [callback]) β‡’ Promise

Returns an array with the file structure.

Kind: instance method of Now
See: https://zeit.co/api#file-structure-endpoint

Param Type Description
id String ID of deployment
[callback] function Callback will be called with (err, fileStructure)

now.getFile(id, fileId, [callback]) β‡’ Promise

Returns the content of a file either as string or object, depending on the filetype.

Kind: instance method of Now
See: https://zeit.co/api#file--endpoint

Param Type Description
id String ID of deployment
fileId String ID of the file
[callback] function Callback will be called with (err, fileContent)

now.getDomains([callback])] β‡’ Promise

Returns an array with all domain names and related aliases.

Kind: instance method of Now See: https://zeit.co/api#get-domains

Param Type Description
[callback] function Callback will be called with (err, domains)

now.addDomain(domain, [callback])] β‡’ Promise

Adds a new domain and returns its data.

Kind: instance method of Now See: https://zeit.co/api#post.domains

Param Type Description
domain object An object containing a string name and a boolean isExternalDNS
[callback] function Callback will be called with (err)

now.deleteDomain(name, [callback])] β‡’ Promise

Deletes a domain name.

Kind: instance method of Now See: https://zeit.co/api#delete-domains

Param Type Description
name String Domain name
[callback] function Callback will be called with (err)

now.getDomainRecords(domain, [callback])] β‡’ Promise

Returns an array with all DNS records configured for a domain name.

Kind: instance method of Now See: https://zeit.co/api#get-domain-records

Param Type Description
name String Domain name
[callback] function Callback will be called with (err, domains)

now.addDomainRecord(domain, recordData, [callback])] β‡’ Promise

Adds a new DNS record for a domain.

Kind: instance method of Now See: https://zeit.co/api#post-domain-records

Param Type Description
domain object An object containing a string name and a boolean isExternalDNS
recordData object An object containing a description of the new record according to the documentation.
[callback] function Callback will be called with (err)

now.deleteDomainRecord(name, recordId, [callback])] β‡’ Promise

Deletes a DNS record associated with a domain.

Kind: instance method of Now See: https://zeit.co/api#delete-domain-records

Param Type Description
domain String Domain name
recordId String Record ID
[callback] function Callback will be called with (err)

now.getCertificates([cn], [callback])] β‡’ Promise

Returns an array of all certificates.

Kind: instance method of Now See: https://zeit.co/api#get-certs

Param Type Description
[cn] String Common Name
[callback] function Callback will be called with (err, certs)

now.createCertificate(cn, [callback])] β‡’ Promise

Creates a new certificate for a domain registered to the user.

Kind: instance method of Now See: https://zeit.co/api#post-certs

Param Type Description
cn String Common Name
[callback] function Callback will be called with (err)

now.renewCertificate(cn, [callback])] β‡’ Promise

Renews an existing certificate.

Kind: instance method of Now See: https://zeit.co/api#post-certs

Param Type Description
cn String Common Name
[callback] function Callback will be called with (err)

now.replaceCertificate(cn, cert, key, [ca], [callback])] β‡’ Promise

Replace an existing certificate.

Kind: instance method of Now See: https://zeit.co/api#put-certs

Param Type Description
cn String Common Name
cert String X.509 certificate
key String Private key for the certificate
ca String CA certificate chain
[callback] function Callback will be called with (err, created)

now.deleteCertificate(cn, [callback])] β‡’ Promise

Deletes a certificate.

Kind: instance method of Now See: https://zeit.co/api#delete-certs

Param Type Description
cn String Common Name
[callback] function Callback will be called with (err)

now.getAliases([id OR callback], [callback]) β‡’ Promise

Returns an array with all aliases.

Kind: instance method of Now
See: https://zeit.co/api#user-aliases

Param Type Description
[id OR callback] String | function ID of deployment or callback
[callback] function Callback will be called with (err, aliases)

now.createAlias(id, alias, [callback]) β‡’ Promise

Creates an alias for the given deployment.

Kind: instance method of Now
See: https://zeit.co/api#create-alias

Param Type Description
id String ID of deployment
alias String Hostname or custom url for the alias
[callback] function Callback will be called with (err, data)

now.deleteAlias(id, [callback]) β‡’ Promise

Deletes an alias and returns a status.

Kind: instance method of Now
See: https://zeit.co/api#delete-user-aliases

Param Type Description
id String ID of alias
[callback] function Callback will be called with (err, status)

now.getSecrets([id OR callback], [callback]) β‡’ Promise

Returns an array with all secrets.

Kind: instance method of Now
See: https://zeit.co/api#get-now-secrets

Param Type Description
[id OR callback] String | function ID of deployment or callback
[callback] function Callback will be called with (err, secrets)

now.createSecret(name, value, [callback]) β‡’ Promise

Creates a secret and returns its ID.

Kind: instance method of Now
See: https://zeit.co/api#post-now-secrets

Param Type Description
name String name for the secret
value String value for the secret
[callback] function Callback will be called with (err, data)

now.renameSecret(id, name, [callback]) β‡’ Promise

Changes the name of the given secret and returns its ID and name.

Kind: instance method of Now
See: https://zeit.co/api#patch-now-secrets

Param Type Description
id String id or name of the secret
name String new name for the secret
[callback] function Callback will be called with (err, data)

now.deleteSecret(id, [callback]) β‡’ Promise

Deletes a secret and returns its ID.

Kind: instance method of Now
See: https://zeit.co/api#delete-now-secrets

Param Type Description
id String ID or name of the secret
[callback] function Callback will be called with (err, status)