JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 67
  • Score
    100M100P100Q8565F
  • License MIT

Full NodeJS implementation of the GitLab API. Supports Promises, Async/Await.

Package Exports

  • node-gitlab-api

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-gitlab-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

dependencies StatusdevDependencies StatusCode Climate

NPM

node-gitlab-api

GitLab API Nodejs library. It wraps the HTTP v4 api library described here.

Table of Contents

Install

# Install from npm
npm install node-gitlab-api

Usage

URL to your GitLab instance should not include /api/v4 path.

// Connection with basic token
const GitlabAPI = require('node-gitlab-api')({
  url:   'http://example.com', // Defaults to http://gitlab.com
  token: 'abcdefghij123456'
})
  
// Connection with oauth token
const GitlabAPI = require('node-gitlab-api')({
  url:   'http://example.com', // Defaults to http://gitlab.com
  oauthToken: 'abcdefghij123456'
})

// Listing users
let users = await gitlab.users.all();

console.log(users);

// Listing projects
let projects = await gitlab.projects.all();

console.log(projects);

General rule about all the function parameters:

  • If its a required parameter, it is a named argument in the functions
  • If its an optional parameter, it is defined in a options object following the named arguments

ie. 

GitlabAPI.projects.create(projectId, {
    //options defined in the gitlab api documentation
})

Docs

Although there are the offical docs for the API, i realised i should still explain the function calls in this library, so i wrote some up!

Contributors

This started off as a fork from node-gitlab but I ended up rewriting 90% of the code. Here are the original work's contributers.

License

MIT

Changelog

1.0.11 (2017-07-20)

  • Fixing the problem where Id was used instead of IId's for Project issues
  • Fixing the naming convention for Project Issues
  • Standadized the use of parseInt in the codebase
  • Removed instances of duplicate code found by code climate

1.0.10 (2017-07-13)

  • Fixing Issues #1, #2, and #3

1.0.9 (2017-07-06)

  • Fixing broken Notes API reference
  • Added Project triggers, members and hooks docs
  • Moved Project Runners into its own scope and seperated out general Runners API logic

1.0.8 (2017-06-30)

  • Adding more to the Project Issue Notes API
  • Updating Readme to show examples of connecting with oauth tokens
  • Begun adding documentation for projects

1.0.7 (2017-06-23)

  • Fixing bug within the Issues API; reference to an old function.

1.0.6 (2017-06-23)

  • Fixing bug within the Labels API; Missing required argument.

1.0.5 (2017-06-23)

  • Fixing bug within the delete API calls. It was missing query parameters

1.0.4 (2017-06-23)

  • Adding more to the Labels API
  • Cleaned up the Issues class

1.0.3 (2017-06-23)

  • Updating problems within the Milestone API
  • Removed the old 'list' calls for projects and issues which displayed a deprecated message. Only all is available now.

1.0.2 (2017-06-22)

  • Updating examples in readme
  • Adding dependancy badges
  • Removing unused test files

1.0.1 (2017-06-21)

  • Initial release
  • TODO: Tests, Examples