@vercel/client

Join the Vercel Community

The official Node.js client for deploying to Vercel.

Usage

Firstly, install the package:

``bash
npm install @vercel/client
`

Next, load it:

`js
const { createDeployment } = require('@vercel/client');
`

Then call inside a for...of loop to follow the progress with the following arguments:

- - a directory path / file path / array of file paths (must be on the same level)
- - An object containing token, an optional teamId and any vercel.json-valid fields

`js
async function deploy() {
let deployment;

for await (const event of createDeployment({
token: process.env.TOKEN,
path: '/Users/me/Code/myproject',
})) {
if (event.type === 'ready') {
deployment = event.payload;
break;
}
}

return deployment;
}
`

Full list of events:

`js
[
// File events
'hashes-calculated',
'file-count',
'file-uploaded',
'all-files-uploaded',
// Deployment events
'created',
'building',
'ready',
'alias-assigned',
'warning',
'error',
];
`

You can also get the events set programmatically:

`js
import { EVENTS } from '@vercel/client';
``