Skip to content

Latest commit

 

History

History
60 lines (48 loc) · 1.16 KB

README.md

File metadata and controls

60 lines (48 loc) · 1.16 KB

Node-opensource

Node-opensource is an API Wrapper that allows you to query the Open Source License API with Nodejs.

Example

const licenses = require('node-opensource');

// Get all known licenses
licenses.all(function(err, data) {
  // Do something with data
})

// Get license from it's OSI ID
licenses.get("MIT", function(err, data) {
  // Do something with data
})

// Get license from keyword
licenses.tagged("copyleft", function(err, data) {
  // Do something with data
})

Using Promises

const licenses = require('node-opensource');

// Get all known licenses
licenses.all()
.then(function(data) {
  // Do something with data
}).catch(function(error) {
  // Error
});

// Get license from it's OSI ID
licenses.get("MIT")
.then(function(data) {
  // Do something with data
}).catch(function(error) {
  // Error
});

// Get license from keyword
licenses.tagged("copyleft")
.then(function(data) {
  // Do something with data
}).catch(function(error) {
  // Error
});

Installing

npm install node-opensource