@vercel/client NPM | npm.io

13.2.2 • Published 6 days ago

Install

Weekly downloads

2,454

License

Apache-2.0

Repository

Last release

6 days ago

@vercel/client

The official Node.js client for deploying to Vercel.

Usage

Firstly, install the package:

npm install @vercel/client

Next, load it:

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

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

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

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:

[
  // 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:

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

@vercel/build-utils @vercel/error-utils @vercel/routing-utils @zeit/fetch async-retry async-sema fs-extra ignore minimatch ms node-fetch querystring sleep-promise tar-fs

@knapsack/app-ui @everything-registry/sub-chunk-981 test-global-vercel-connect @commercelayer/vercel-builder @carmel/sdk

6 days ago

17 days ago

25 days ago

1 month ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

10 months ago

10 months ago

9 months ago

6 months ago

6 months ago

7 months ago

6 months ago

8 months ago

7 months ago

8 months ago

8 months ago

9 months ago

9 months ago

10 months ago

11 months ago

11 months ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

12.0.5-canary.0

2 years ago

12.0.2-canary.0

2 years ago

12.0.2-canary.1

2 years ago

2 years ago

12.0.1-canary.0

2 years ago

2 years ago

2 years ago

2 years ago

11.0.3-canary.0

2 years ago

10.4.2-canary.7

2 years ago

10.4.2-canary.6

2 years ago

2 years ago

10.4.2-canary.5

2 years ago

2 years ago

10.4.2-canary.4

2 years ago

2 years ago

10.4.2-canary.3

2 years ago

2 years ago

10.4.2-canary.2

2 years ago

11.0.1-canary.0

2 years ago

11.0.1-canary.1

2 years ago

11.0.1-canary.4

2 years ago

11.0.1-canary.2

2 years ago

11.0.1-canary.3

2 years ago

2 years ago

10.4.2-canary.1

2 years ago

10.4.2-canary.0

2 years ago

11.0.4-canary.0

2 years ago

11.0.4-canary.2

2 years ago

11.0.4-canary.1

2 years ago

11.0.2-canary.0

2 years ago

2 years ago

10.3.1-canary.8

2 years ago

10.3.1-canary.7

2 years ago

10.3.1-canary.6

2 years ago

10.3.1-canary.5

2 years ago

10.3.1-canary.4

2 years ago

10.4.1-canary.0

2 years ago

10.3.1-canary.3

2 years ago

10.3.1-canary.2

2 years ago

10.3.1-canary.1

2 years ago

10.3.1-canary.0

2 years ago

2 years ago

10.2.3-canary.50

2 years ago

10.2.3-canary.51

2 years ago

10.2.3-canary.52

2 years ago

10.2.3-canary.53

2 years ago

10.2.3-canary.48

2 years ago

10.2.3-canary.49

2 years ago

10.2.3-canary.40

2 years ago

10.2.3-canary.41

2 years ago

10.2.3-canary.42

2 years ago

10.2.3-canary.43

2 years ago

10.2.3-canary.44

2 years ago

10.2.3-canary.45

2 years ago

10.2.3-canary.46

2 years ago

10.2.3-canary.47

2 years ago

10.2.3-canary.30

2 years ago

10.2.3-canary.31

2 years ago

10.2.3-canary.32

2 years ago

10.2.3-canary.33

2 years ago

10.2.3-canary.34

2 years ago

10.2.3-canary.35

2 years ago

10.2.3-canary.36

2 years ago

10.2.3-canary.37

2 years ago

10.2.3-canary.38

2 years ago

10.2.3-canary.39

2 years ago

10.2.3-canary.20

2 years ago

10.2.3-canary.21

2 years ago

10.2.3-canary.22

2 years ago

10.2.3-canary.23

2 years ago

10.2.3-canary.24

2 years ago

10.2.3-canary.25

2 years ago

10.2.3-canary.26

2 years ago

10.2.3-canary.27

2 years ago

10.2.3-canary.28

2 years ago

10.2.3-canary.29

2 years ago

10.2.3-canary.19

2 years ago

10.2.3-canary.12

3 years ago

10.2.3-canary.13

3 years ago

10.2.3-canary.14

3 years ago

10.2.3-canary.15

3 years ago

10.2.3-canary.16

2 years ago

10.2.3-canary.17

2 years ago

10.2.3-canary.18

2 years ago

10.2.3-canary.10

3 years ago

10.2.3-canary.11

3 years ago

10.2.3-canary.9

3 years ago

10.2.3-canary.8

3 years ago

10.2.3-canary.7

3 years ago

10.2.3-canary.6

3 years ago

10.2.3-canary.5

3 years ago

10.2.3-canary.4

3 years ago

10.2.3-canary.3

3 years ago

10.2.3-canary.2

3 years ago

10.2.3-canary.1

3 years ago

10.2.3-canary.0

3 years ago

3 years ago

10.2.2-canary.0

3 years ago

10.1.2-canary.8

3 years ago

10.2.1-canary.0

3 years ago

3 years ago

3 years ago

10.1.2-canary.7

3 years ago

10.1.2-canary.6

3 years ago

10.1.2-canary.5

3 years ago

10.1.2-canary.4

3 years ago

10.1.2-canary.3

3 years ago

10.1.2-canary.2

3 years ago

10.1.2-canary.1

3 years ago

10.1.2-canary.0

3 years ago

3 years ago

10.1.1-canary.1

3 years ago

3 years ago

10.1.1-canary.0

3 years ago

3 years ago

10.0.1-canary.5

3 years ago

10.0.1-canary.4

3 years ago

10.0.1-canary.3

3 years ago

10.0.1-canary.2

3 years ago

10.0.1-canary.1

3 years ago

10.0.1-canary.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

9.0.7-canary.10

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

8.2.2-canary.10

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago