API Docs for: 0.0.4
Show:

GITLabConnection Class

Defined in: lib\gitlab\connection.js:3
Module: Connections

GITLab Connection constructor

Constructor

GITLabConnection

(
  • name
  • fqdn
  • authentication
  • configuration
)

Defined in lib\gitlab\connection.js:3

Parameters:

  • name String
  • fqdn String
  • authentication Authentication
  • configuration Object

Methods

addDeployKey

(
  • id
)
Array | > | Number

Defined in lib\gitlab\connection.js:96

Parameters:

  • id Number

Returns:

Array | > | Number:

Current deployment key array.

addProjectWebhook

(
  • project
  • url
  • [conditions]
)
Promise | > | Project

Defined in lib\gitlab\connection.js:320

Parameters:

  • project Project
  • url String

    Webhook URL

  • [conditions] Object optional

Returns:

Promise | > | Project:

addWebhook

(
  • url
  • [conditions]
)
Promise | > | Project private

Defined in lib\gitlab\connection.js:385

Written to be added to a Promise chain for a project.

Parameters:

  • url String
  • [conditions] Object optional

Returns:

Promise | > | Project:

cleanHook

(
  • url
)
Promise | > | Project private

Defined in lib\gitlab\connection.js:338

Written to be added to a Promise chain for a project.

Deletes any webhook matching the passed URL and finishes when complete.

Parameters:

  • url String

Returns:

Promise | > | Project:

commitChain

(
  • url
  • commits
  • finish
  • failure
)
private

Defined in lib\gitlab\connection.js:455

Internal method for resolving a request for commits

Parameters:

  • url String
  • commits Array
  • finish Function
  • failure Function

deleteWebhook

(
  • project
  • [branch]
)

Defined in lib\gitlab\connection.js:417

Parameters:

  • project Project
  • [branch] String optional

(
  • identifier
  • failable
)
Function | > | Promise | > | Project

Defined in lib\gitlab\connection.js:225

Parameters:

  • identifier String | Number

    Name or ID for the key to enable

  • failable Boolean

    When true, requesting a key that isn't available in the Project will fail the Promise. Otherwise the requested key is simply ignored.

Returns:

Function | > | Promise | > | Project:

(
  • identifier
  • failable
)
Function | > | Promise | > | Project

Defined in lib\gitlab\connection.js:272

Parameters:

  • identifier Number

    ID for the key to delete

  • failable Boolean

    When true, requesting a key that isn't available in the Project will fail the Promise. Otherwise the requested key is simply ignored.

Returns:

Function | > | Promise | > | Project:

enableSystemProjectDeployKeys

(
  • project
)
Promise | > | Project

Defined in lib\gitlab\connection.js:300

Parameters:

Returns:

Promise | > | Project:

getCommits

(
  • project
  • [branch]
)

Defined in lib\gitlab\connection.js:437

Parameters:

  • project Project
  • [branch] String optional

getProject

(
  • identifier
)
Promise

Defined in lib\gitlab\connection.js:171

Parameters:

  • identifier Object

Returns:

Promise:

getProjectDeployKeys

(
  • project
)
Promise

Defined in lib\gitlab\connection.js:208

Parameters:

Returns:

Promise:

getProjectWebhooks

(
  • project
)
Promise | > | Project

Defined in lib\gitlab\connection.js:365

Parameters:

Returns:

Promise | > | Project:

removeDeployKey

(
  • id
)
Array | > | Number

Defined in lib\gitlab\connection.js:109

Parameters:

  • id Number

Returns:

Array | > | Number:

Current deployment key array.

retrieveURL

(
  • url
)
Promise

Defined in lib\gitlab\connection.js:123

Manages resolution of all pages for a request an returning all results as one array.

Parameters:

  • url String

Returns:

Promise:

retrieveURL

(
  • url
  • [options]
  • [page]
)
Promise private

Defined in lib\gitlab\connection.js:22

Handles pushing a request to the Gitlab host.

Parameters:

  • url String
  • [options] Object optional
  • [page] Number optional

Returns:

Promise: