๐ซ now client
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
- Now
- new Now([token])
- .getDeployments([callback]) โ
Promise
- .getDeployment(id, [callback]) โ
Promise
- .createDeployment(body, [callback]) โ
Promise
- .deleteDeployment(id, [callback]) โ
Promise
- .getFiles(id, [callback]) โ
Promise
- .getFile(id, fileId, [callback]) โ
Promise
- .getDomains([callback]) โ
Promise
- .addDomain(domain, [callback]) โ
Promise
- .deleteDomain(name, [callback]) โ
Promise
- .getCertificates([cn], [callback]) โ
Promise
- .createCertificate(cn, [callback]) โ
Promise
- .renewCertificate(cn, [callback]) โ
Promise
- .replaceCertificate(cn, cert, key, [ca], [callback]) โ
Promise
- .deleteCertificate(cn, [callback]) โ
Promise
- .getAliases([id OR callback], [callback]) โ
Promise
- .createAlias(id, alias, [callback]) โ
Promise
- .deleteAlias(id, [callback]) โ
Promise
- .getSecrets([id OR callback], [callback]) โ
Promise
- .createSecret(name, value, [callback]) โ
Promise
- .renameSecret(id, name, [callback]) โ
Promise
- .deleteSecret(id, [callback]) โ
Promise
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. |
Promise
now.getDeployments([callback]) โ 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) |
Promise
now.getDeployment(id, [callback]) โ 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) |
Promise
now.createDeployment(body, [callback]) โ 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) |
Promise
now.deleteDeployment(id, [callback]) โ 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) |
Promise
now.getFiles(id, [callback]) โ 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) |
Promise
now.getFile(id, fileId, [callback]) โ 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) |
Promise
now.getDomains([callback])] โ 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) |
Promise
now.addDomain(domain, [callback])] โ 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) |
Promise
now.deleteDomain(name, [callback])] โ 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) |
Promise
now.getDomainRecords(domain, [callback])] โ 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) |
Promise
now.addDomainRecord(domain, recordData, [callback])] โ 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) |
Promise
now.deleteDomainRecord(name, recordId, [callback])] โ 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) |
Promise
now.getCertificates([cn], [callback])] โ 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) |
Promise
now.createCertificate(cn, [callback])] โ 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) |
Promise
now.renewCertificate(cn, [callback])] โ 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) |
Promise
now.replaceCertificate(cn, cert, key, [ca], [callback])] โ 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) |
Promise
now.deleteCertificate(cn, [callback])] โ 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) |
Promise
now.getAliases([id OR callback], [callback]) โ 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) |
Promise
now.createAlias(id, alias, [callback]) โ 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) |
Promise
now.deleteAlias(id, [callback]) โ 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) |
Promise
now.getSecrets([id OR callback], [callback]) โ 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) |
Promise
now.createSecret(name, value, [callback]) โ 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) |
Promise
now.renameSecret(id, name, [callback]) โ 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) |
Promise
now.deleteSecret(id, [callback]) โ 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) |