npmpackage.info

Gathering detailed insights and metrics for @xiaoxu_dev/azure-devops-node-api

@xiaoxu_dev/azure-devops-node-api - 10.1.13 | npmpackage.info

@xiaoxu_dev/azure-devops-node-api

Azure DevOps Client for Node.js

10.1.13

488

NOASSERTION

TypeScript

3.83 MB

7.4

Installations

npm install @xiaoxu_dev/azure-devops-node-api

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

12.16.1

NPM Version

6.14.4 Pull Requests

Open

14

Total

247

Closed

57

Merged

176

Issues

Open

8

Total

370

Closed

362

Releases

Update 2022.1

v6.7

Updated on Jul 26, 2022

>= TFS 2018 Update 2

v6.6.2

Updated on Feb 13, 2019

>= TFS 2017 Update 2

v6.2.8-preview

Updated on Feb 13, 2019

>= TFS 2017 Update 1

v5.1.2

Updated on Feb 13, 2019

>= TFS 2017 RTW

v5.0.0

Updated on Feb 13, 2019

>= TFS 2015 Update 2

v0.7.0

Updated on Feb 13, 2019

View All 6 releases

Languages

TypeScript

JavaScript

TypeScript (99.5%)

JavaScript (0.5%)

Developer

Microsoft

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

NOASSERTION License

488 Stars

311 Commits

236 Forks

100 Watchers

72 Branches

135 Contributors

Updated on Jul 15, 2025

Maintainers

View All 135 Contributors

Package Meta Information

Latest Version

10.1.13

Package Id

@xiaoxu_dev/azure-devops-node-api@10.1.13

Unpacked Size

3.83 MB

Size

473.57 kB

File Count

142

NPM Version

6.14.4

Node Version

12.16.1

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

tunnel typed-rest-client underscore

Dev Dependencies

@types/mocha @types/shelljs mocha nock shelljs typescript @types/node

Azure DevOps Client for Node.js

Integrate with Azure DevOps from your Node.js apps.

Install the library

npm install azure-devops-node-api --save

News

vso-node-api has been renamed and released as azure-devops-node-api

Get started

Samples

See samples for complete coding examples

Install the library

npm install azure-devops-node-api --save

Intellisense

Create a connection

1import * as azdev from "azure-devops-node-api";
2
3// your collection url
4let orgUrl = "https://dev.azure.com/yourorgname";
5
6let token: string = process.env.AZURE_PERSONAL_ACCESS_TOKEN; // e.g "cbdeb34vzyuk5l4gxc4qfczn3lko3avfkfqyb47etahq6axpcqha"; 
7
8let authHandler = azdev.getPersonalAccessTokenHandler(token); 
9let connection = new azdev.WebApi(orgUrl, authHandler);

Get an instance of a client

1import * as ba from "azure-devops-node-api/BuildApi";
2
3let build: ba.IBuildApi = await connection.getBuildApi();

Available clients

These clients are available:

Build
Core
Dashboard
ExtensionManagement
FeatureManagement
FileContainer
Git
Locations
Notification
Policy
Profile
ProjectAnalysis
Release
SecurityRoles
TaskAgent
Task
Test
Tfvc
Wiki
Work
WorkItemTracking
WorkItemTrackingProcess
WorkItemTrackingProcessDefinitions

Use the client

Coding is easy using linear coding with async/await in TypeScript

1import * as bi from "azure-devops-node-api/interfaces/BuildInterfaces";
2
3async function run() {
4    let project: string = "myProject";
5    let defs: bi.DefinitionReference[] = await build.getDefinitions(project);
6
7    defs.forEach((defRef: bi.DefinitionReference) => {
8        console.log(`${defRef.name} (${defRef.id})`);
9    });    
10}
11
12run();

APIs

To see what APIs are available, see the appropriate client interface. For example, GitApi.ts

More detailed information for the endpoints of each API can be found at https://docs.microsoft.com/en-us/rest/api/vsts/?view=vsts-rest-4.1

Running Samples

Pre-reqs: Node >= 4.4.7 LTS and typescript (tsc) >= 1.8

Run npm install first

Set environment variables using set or export:

1API_URL=https://dev.azure.com/yourorgname
2
3// use your token
4API_TOKEN=cbdeb34vzyuk5l4gxc4qfczn3lko3avfkfqyb47etahq6axpcqha  
5
6API_PROJECT=myProject

Run samples:

1$ npm run samples

Run a specific sample:

1$ npm run samples -- projectAnalysis

API and TFS Mapping

Below you'll find a quick mapping of azure-devops-node-api versions and their corresponding TFS releases. All API versions will work on the TFS version mentioned as well as later TFS versions.

TFS Version	Node API VERSION
Azure DevOps Server vNext	8.0.0
Azure DevOps Server 2019	7.0.0
TFS 2018 Update 2	6.6.2
TFS 2017 Update 2	6.2.8-preview
TFS 2017 Update 1	5.1.2
TFS 2017 RTW	5.0.0
TFS 2015 Update 2	0.7.0

Contributing

To contribute to this repository, see the contribution guide

Issues

Feel free to file an issue in this repo.

Do you think there might be a security issue? Have you been phished or identified a security vulnerability? Please don't report it here - let us know by sending an email to secure@microsoft.com.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

No vulnerabilities found.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

9

License

Determines if the project has defined a license.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

8

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

7.4

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More