Socket
Socket
Sign inDemoInstall

iridium

Package Overview
Dependencies
8
Maintainers
1
Versions
157
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 7.0.0-alpha.17 to 7.0.0

2

package.json
{
"name": "iridium",
"version": "7.0.0-alpha.17",
"version": "7.0.0",
"author": "Benjamin Pannell <admin@sierrasoftworks.com>",

@@ -5,0 +5,0 @@ "description": "A custom lightweight ORM for MongoDB designed for power-users",

@@ -21,16 +21,9 @@ # Iridium

## Installation
Iridium is a relatively complex library, as a result its installation requires a little more than just `npm install` to get right.
This is, unfortunately, a result of the way TypeScript handles modules at the moment - but they're working on making the workflow
better and we'll always try to stay as up to date as possible.
Iridium makes use of the latest set of `@types` TypeScript definitions files, allowing you to install everything using just a
simple `npm install`.
```bash
npm install iridium --save
typings install -S 'npm!bluebird' 'npm!mongodb' 'npm!lodash'
typings install -SA node es6-promise # don't install es6-promise if you're targetting ES6
```
- **ES6 Users** - If you're targetting ES6, then you'll want to ensure that you don't install es6-promise above. It will conflict with
the ES6 promise library and cause problems.
## Features

@@ -51,7 +44,8 @@ - **Built with TypeScript** and designed for ease of use, you'll be hard pressed to find another Node.js ORM as easy to pick

## Requirements
Iridium is built on top of a number of very modern technologies, including TypeScript 1.8, JavaScript ES6 (though we do compile
to ES5 for compatibility with existing Node.js implementations) and the latest MongoDB Node.js Driver (version 2.1).
Iridium is built on top of a number of very modern technologies, including TypeScript 2.0, JavaScript ES6 and the latest MongoDB
Node.js Driver (version 2.2). You'll need to be running Node.js 6.x, or 4.x with the `--harmony` flag to run version 7 of Iridium.
For older versions of Node.js, please considering using version 6 of Iridium instead.
For starters, you will need to be running MongoDB 2.6 or later in order to use Iridium - however we recommend you use MongoDB 3.0
due to the various performance improvements they've made. If you're working with TypeScript, you will also need to use the 1.5
For starters, you will need to be running MongoDB 2.6 or later in order to use Iridium - however we recommend you use MongoDB 3.1
due to the various performance improvements they've made. If you're working with TypeScript, you will also need to use the 2.0
compiler or risk having the Iridium type definitions break your project.

@@ -58,0 +52,0 @@

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc