Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sobesednik/noddy

Parse Node.js version and compare with another one.
https://github.com/sobesednik/noddy

nodejs semver

Last synced: about 2 months ago
JSON representation

Parse Node.js version and compare with another one.

Awesome Lists containing this project

README

        

# noddy

[![npm version](https://badge.fury.io/js/noddy.svg)](https://badge.fury.io/js/noddy)

`noddy` is a Node.js package which allows to parse `process.version` string into
major, minor and patch numbers, and compare a specific version with the current
one.

```sh
npm i noddy
```

## ES5

The package uses some newer language features. For your convenience, it's been
transpiled to be compatible with Node 4. You can use the following snippet.

```js
const noddy = require('noddy/es5')
```

### API

The package provides a set of functions.

## `noddy.parseVersion(version?: string): { major: number, minor: number, patch: number }`

Call `parseVersion` to extract the version object from the version string.
Don't pass an argument to parse the current Node.js version.

```js
const { parseVersion } = require('noddy')

parseVersion() // { major: 8, minor: 9, patch: 3 }
parseVersion('v5.10.0') // { major: 5, minor: 10, patch: 0 }
```

## `noddy.nodeGt(version?: string): boolean`

Check if the current Node.js version is greater than the specified one.

```js
const { nodeGt } = require('noddy')

process.version // v8.9.3
nodeGt('v2.3.4') // true
nodeGt(process.version) // false
nodeGt('v20.3.4') // false
```

## `noddy.nodeGte(version?: string): boolean`

Check if the current Node.js version is greater than or equal to the specified
one.

```js
const { nodeGte } = require('noddy')

process.version // v8.9.3
nodeGte('v2.3.4') // true
nodeGte(process.version) // true
nodeGte('v20.3.4') // false
```

## `noddy.nodeLt(version?: string): boolean`

Check if the current Node.js version is less than the specified one.

```js
const { nodeLt } = require('noddy')

process.version // v8.9.3
nodeLt('v2.3.4') // false
nodeLt(process.version) // false
nodeLt('v20.3.4') // true
```

## `noddy.nodeLte(version?: string): boolean`

Check if the current Node.js version is less than or equal to the specified one.

```js
const { nodeLte } = require('noddy')

process.version // v8.9.3
nodeLte('v2.3.4') // false
nodeLte(process.version) // true
nodeLte('v20.3.4') // true
```

---

(c) [sobes.io][1] 2018

[1]: https://sobes.io