azure-devops-node-api

azure-devops-node-api

Version 15.1.0
Published 1 month ago
4.85 MB
2 dependencies
MIT license

Install

npm i azure-devops-node-api

yarn add azure-devops-node-api

pnpm add azure-devops-node-api

Overview

Node client for Azure DevOps and TFS REST APIs

Functions

function getBasicHandler

getBasicHandler: (
    username: string,
    password: string,
    allowCrossOriginAuthentication?: boolean
) => VsoBaseInterfaces.IRequestHandler;

Methods to return handler objects (see handlers folder)

function getBearerHandler

getBearerHandler: (
    token: string,
    allowCrossOriginAuthentication?: boolean
) => VsoBaseInterfaces.IRequestHandler;

function getHandlerFromToken

getHandlerFromToken: (
    token: string,
    allowCrossOriginAuthentication?: boolean
) => VsoBaseInterfaces.IRequestHandler;

function getNtlmHandler

getNtlmHandler: (
    username: string,
    password: string,
    workstation?: string,
    domain?: string
) => VsoBaseInterfaces.IRequestHandler;

function getPersonalAccessTokenHandler

getPersonalAccessTokenHandler: (
    token: string,
    allowCrossOriginAuthentication?: boolean
) => VsoBaseInterfaces.IRequestHandler;

Classes

class WebApi

class WebApi {}

constructor

constructor(
    defaultUrl: string,
    authHandler: VsoBaseInterfaces.IRequestHandler,
    options?: VsoBaseInterfaces.IRequestOptions,
    requestSettings?: IWebApiRequestSettings
);

property authHandler

authHandler: VsoBaseInterfaces.IRequestHandler;

property isNoProxyHost

isNoProxyHost: (_url: string) => boolean;

Determines if the domain is exluded for proxy via the no_proxy env var
Parameter url
: the server url

property options

options: VsoBaseInterfaces.IRequestOptions;

property rest

rest: rm.RestClient;

property serverUrl

serverUrl: string;

property userAgent

userAgent?: string;

property vsoClient

vsoClient: vsom.VsoClient;

method connect

connect: () => Promise<lim.ConnectionData>;

method createWithBearerToken

static createWithBearerToken: (
    defaultUrl: string,
    token: string,
    options?: VsoBaseInterfaces.IRequestOptions
) => WebApi;

Convenience factory to create with a bearer token.
Parameter defaultServerUrl
default server url to use when creating new apis from factory methods
Parameter defaultAuthHandler
default authentication credentials to use when creating new apis from factory methods

method getAlertApi

getAlertApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<alertm.IAlertApi>;

Each factory method can take a serverUrl and a list of handlers if these aren't provided, the default url and auth handler given to the constructor for this class will be used

method getBuildApi

getBuildApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<buildm.IBuildApi>;

method getCixApi

getCixApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<cixm.ICixApi>;

method getCoreApi

getCoreApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<corem.ICoreApi>;

method getDashboardApi

getDashboardApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<dashboardm.IDashboardApi>;

method getExtensionManagementApi

getExtensionManagementApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<extmgmtm.IExtensionManagementApi>;

method getFeatureManagementApi

getFeatureManagementApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<featuremgmtm.IFeatureManagementApi>;

method getFileContainerApi

getFileContainerApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<filecontainerm.IFileContainerApi>;

method getGalleryApi

getGalleryApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<gallerym.IGalleryApi>;

method getGitApi

getGitApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<gitm.IGitApi>;

method getLocationsApi

getLocationsApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<locationsm.ILocationsApi>;

method getManagementApi

getManagementApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<managementm.IManagementApi>;

method getNotificationApi

getNotificationApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<notificationm.INotificationApi>;

method getPipelinesApi

getPipelinesApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<pipelinesm.IPipelinesApi>;

method getPolicyApi

getPolicyApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<policym.IPolicyApi>;

method getProfileApi

getProfileApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<profilem.IProfileApi>;

method getProjectAnalysisApi

getProjectAnalysisApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<projectm.IProjectAnalysisApi>;

method getReleaseApi

getReleaseApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<releasem.IReleaseApi>;

method getSecurityRolesApi

getSecurityRolesApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<securityrolesm.ISecurityRolesApi>;

method getTaskAgentApi

getTaskAgentApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<taskagentm.ITaskAgentApi>;

method getTaskApi

getTaskApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<taskm.ITaskApi>;

method getTestApi

getTestApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<testm.ITestApi>;

method getTestPlanApi

getTestPlanApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<testplanm.ITestPlanApi>;

method getTestResultsApi

getTestResultsApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<testresultsm.ITestResultsApi>;

method getTfvcApi

getTfvcApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<tfvcm.ITfvcApi>;

method getWikiApi

getWikiApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<wikim.IWikiApi>;

method getWorkApi

getWorkApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<workm.IWorkApi>;

method getWorkItemTrackingApi

getWorkItemTrackingApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<workitemtrackingm.IWorkItemTrackingApi>;

method getWorkItemTrackingProcessApi

getWorkItemTrackingProcessApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<workitemtrackingprocessm.IWorkItemTrackingProcessApi>;

method getWorkItemTrackingProcessDefinitionApi

getWorkItemTrackingProcessDefinitionApi: (
    serverUrl?: string,
    handlers?: VsoBaseInterfaces.IRequestHandler[]
) => Promise<workitemtrackingprocessdefinitionm.IWorkItemTrackingProcessDefinitionsApi>;

Interfaces

interface IWebApiRequestSettings

interface IWebApiRequestSettings {}

property productName

productName: string;

property productVersion

productVersion: string;

property userAgent

userAgent?: string;

Package Files (1)

WebApi.d.ts

Dependencies (2)

Dev Dependencies (9)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/azure-devops-node-api.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/azure-devops-node-api)

HTML

<a href="https://www.jsdocs.io/package/azure-devops-node-api"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 1 month ago.
Package analyzed in 5588 ms.
Missing or incorrect documentation? Open an issue for this package.

azure-devops-node-api

Install

Overview

Index

Functions

Classes

Interfaces

Functions

function getBasicHandler

function getBearerHandler

function getHandlerFromToken

function getNtlmHandler

function getPersonalAccessTokenHandler

Classes

class WebApi

constructor

property authHandler

property isNoProxyHost

Parameter url

property options

property rest

property serverUrl

property userAgent

property vsoClient

method connect

method createWithBearerToken

Parameter defaultServerUrl

Parameter defaultAuthHandler

method getAlertApi

method getBuildApi

method getCixApi

method getCoreApi

method getDashboardApi

method getExtensionManagementApi

method getFeatureManagementApi

method getFileContainerApi

method getGalleryApi

method getGitApi

method getLocationsApi

method getManagementApi

method getNotificationApi

method getPipelinesApi

method getPolicyApi

method getProfileApi

method getProjectAnalysisApi

method getReleaseApi

method getSecurityRolesApi

method getTaskAgentApi

method getTaskApi

method getTestApi

method getTestPlanApi

method getTestResultsApi

method getTfvcApi

method getWikiApi

method getWorkApi

method getWorkItemTrackingApi

method getWorkItemTrackingProcessApi

method getWorkItemTrackingProcessDefinitionApi

Interfaces

interface IWebApiRequestSettings

property productName

property productVersion

property userAgent

Package Files (1)

Dependencies (2)

Dev Dependencies (9)

Peer Dependencies (0)

Badge