Skip to content

Commit e5475d6

Browse files
branding changes
1 parent e39dc4e commit e5475d6

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
# Visual Studio Team Services Client for Node.js
1+
# Azure DevOps Client for Node.js
22

3-
Integrate with Visual Studio Team Services from your Node.js apps.
3+
Integrate with Azure DevOps from your Node.js apps.
44

55
### Install the library
66
```
7-
npm install vso-node-api --save
7+
npm install azure-devops-node-api --save
88
```
99

1010
## News
1111

12-
6.3.2 has been released and is out of preview. This release contains the latest generated 4.0 VSTS/TFS api contracts. It also consumes the latest typed-rest-client.
13-
14-
Note: as of released 6.3.2 version, the web api create methods need to be async so you must use await. For example, note the `await` [in this sample](https://github.com/Microsoft/vsts-node-api/blob/master/samples/build.ts#L11)
12+
vso-node-api has been renamed and released as azure-devops-node-api
1513

1614
## Get started
1715

@@ -21,36 +19,36 @@ See [samples](./samples) for complete coding examples
2119

2220
### Install the library
2321
```
24-
npm install vso-node-api --save
22+
npm install azure-devops-node-api --save
2523
```
2624

2725
![Intellisense](docs/intellisense.png)
2826

2927
### Create a connection
3028
```javascript
31-
import * as vsts from 'vso-node-api';
29+
import * as azdev from 'azure-devops-node-api';
3230

3331
// your collection url
34-
let collectionUrl = "https://fabrikam.visualstudio.com/defaultcollection";
32+
let orgUrl = "https://dev.azure.com/yourorgname";
3533

3634
// ideally from config
3735
let token: string = "cbdeb34vzyuk5l4gxc4qfczn3lko3avfkfqyb47etahq6axpcqha";
3836

3937
let authHandler = vsts.getPersonalAccessTokenHandler(token);
40-
let connection = new vsts.WebApi(collectionUrl, authHandler);
38+
let connection = new azdev.WebApi(orgUrl, authHandler);
4139
```
4240

4341
### Get an instance of a client
4442

4543
```javascript
46-
import * as ba from 'vso-node-api/BuildApi';
44+
import * as ba from 'azure-devops-node-api/BuildApi';
4745

4846
let vstsBuild: ba.IBuildApi = await connection.getBuildApi();
4947
```
5048

5149
#### Available clients
5250

53-
These clients are available in the new 6.x preview API (`npm install vso-node-api@preview`)
51+
These clients are available:
5452

5553
* Build
5654
* Core
@@ -81,7 +79,7 @@ These clients are available in the new 6.x preview API (`npm install vso-node-ap
8179
Coding is easy using linear coding with async/await in typescript
8280

8381
```javascript
84-
import * as bi from 'vso-node-api/interfaces/BuildInterfaces';
82+
import * as bi from 'azure-devops-node-api/interfaces/BuildInterfaces';
8583

8684
async function run() {
8785
let project: string = 'myProject';
@@ -108,7 +106,7 @@ Run `npm install` first
108106
Set environment variables using set or export:
109107

110108
```bash
111-
API_URL=https://fabrikam.visualstudio.com/defaultcollection
109+
API_URL=https://dev.azure.com/yourorgname
112110

113111
// use your token
114112
API_TOKEN=cbdeb34vzyuk5l4gxc4qfczn3lko3avfkfqyb47etahq6axpcqha

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "vso-node-api",
3-
"description": "Node client for Visual Studio Online/TFS REST APIs",
4-
"version": "6.5.3",
2+
"name": "azure-devops-node-api",
3+
"description": "Node client for Azure DevOps and TFS REST APIs",
4+
"version": "6.6.0",
55
"main": "./WebApi.js",
66
"types": "./WebApi.d.ts",
77
"scripts": {
@@ -11,12 +11,14 @@
1111
},
1212
"repository": {
1313
"type": "git",
14-
"url": "https://github.com/Microsoft/vso-node-api"
14+
"url": "https://github.com/Microsoft/azure-devops-node-api"
1515
},
1616
"author": "Microsoft Corporation",
1717
"contributors": [
1818
"Bryan MacFarlane <[email protected]>",
19+
"Daniel McCormick<[email protected]>",
1920
"Scott Dallamura <[email protected]>",
21+
"Stephen Franceschelli<[email protected]>",
2022
"Teddy Ward <[email protected]>"
2123
],
2224
"license": "MIT",

0 commit comments

Comments
 (0)