https://github.com/sidneys/npm-check-global-updates

Find newer versions of global npm packages
https://github.com/sidneys/npm-check-global-updates

Last synced: about 2 months ago
JSON representation

Find newer versions of global npm packages

• Host: GitHub
• URL: https://github.com/sidneys/npm-check-global-updates
• Owner: sidneys
• License: mit
• Created: 2017-06-07T01:03:04.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-04-18T14:06:45.000Z (over 1 year ago)
• Last Synced: 2024-10-06T14:10:57.592Z (3 months ago)
• Language: JavaScript
• Size: 196 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# npm-check-global-updates [![Beta](https://img.shields.io/badge/status-beta-red.svg?style=flat)]() [![npm](https://img.shields.io/npm/v/npm-check-global-updates.svg?style=flat-square)](https://npmjs.com/package/npm-check-global-updates) [![dependencies](https://img.shields.io/david/sidneys/npm-check-global-updates.svg?style=flat-square)](https://npmjs.com/package/npm-check-global-updates) [![devDependencies](https://img.shields.io/david/dev/sidneys/npm-check-global-updates.svg?style=flat-square)](https://npmjs.com/package/desktop-dimmer)

------



  Find newer versions of global npm packages.


  Supports command line and programmatic usage.


  Available for macOS, Windows and Linux.



------

## Contents

1. [Commandline Usage](#commandline_usage)

1. [Programmatic Usage](#programmatic_usage)

1. [Platform Support](#platform_support)

1. [Roadmap](#roadmap)

1. [Contribute](#contribute)

1. [Author](#author)

##  Commandline Usage

### Installation

```bash

$ npm install --global npm-check-global-updates

```

### Usage

```bash

$ npm-check-global-updates

```

### Show all Options

```bash

$ npm-check-global-updates --help

```

### Example

```bash

$ npm-check-global-updates

>> [email protected] [email protected]

```

##  Programmatic Usage

### Installation

```bash

$ npm install npm-check-global-updates

```

### API

The module returns a `Function` which returns a `Promise`.

```js

const checkGlobalUpdates = require('npm-check-global-updates')

checkGlobalUpdates()

.then((result) => {

    console.log(result);

})

```

The `Promise` resolves with an `Array`:

 - *Array* - **Package list (name@version)**

### Example

```js

const checkGlobalUpdates = require('npm-check-global-updates')

checkGlobalUpdates()

.then((packages) => {

    console.log(packages);

    // Returns:

    // [ '[email protected]', '[email protected]' ]

})

.catch((err) => {

    console.error(err);

})

```

##  Platform Support

Tested on:

- macOS Sierra

- Windows 10 Anniversary

- Ubuntu 17.10

##  Roadmap ![img](https://img.shields.io/badge/proposals-welcome-green.svg?style=flat)

- [ ] CI-based automated Testing

##  Contribute ![Contribute](https://img.shields.io/badge/contributions-wanted-red.svg?style=flat-square)

Read the [contribution documentation](https://github.com/sidneys/npm-check-global-updates/blob/release/CONTRIBUTING.md) first.

- [Dev Chat](https://gitter.im/npm-check-global-updates): Talk about features and suggestions.

- [Issues](https://github.com/sidneys/npm-check-global-updates/issues) File bugs and document issues.

##  Author

[sidneys](http://sidneys.github.io) 2017