now client
DEPRECATED: Read more here.
The official JavaScript client for interacting with the now instant API (please note that this API only allows you to send strings, it doesn't support streaming - but binary files can be encoded as base64 strings).
Usage
Firstly, install the package using npm:
npm install --save now-client
Next, load it:
const NowClient = require('now-client')
Then initialize it:
-
<token>
holds your token, which can obtained here (optional, will read from~/.now/auth.json
if not defined - you can also define it using theNOW_TOKEN
environment variable) -
<team>
specifies the ID of the team to which the actions should apply (optional)
const now = new NowClient(<token>, <team>)
And finally, you can use its methods to retrieve data:
await now.getDeployments()
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 | String |
Domain name |
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)
|