# mojoin-core

Latest version **0.0.6** (published 2018-10-15) · ISC license · 0 weekly downloads

## Install

```sh
npm install mojoin-core
pnpm add mojoin-core
yarn add mojoin-core
bun add mojoin-core
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2018-10-15 |
| First published | 2018-08-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 95.9 KB |
| Known vulnerabilities | 0 (+35 in 4 direct dependencies) |
| Install scripts | no |
| Author | Ingo Eichhorst |
| Maintainers | ingo-eichhorst |

## Links

- npm: https://www.npmjs.com/package/mojoin-core
- npm.io page: https://npm.io/package/mojoin-core

## Dependencies (11)

- [axios](https://npm.io/package/axios.md) 0.18.0
- [debug](https://npm.io/package/debug.md) 4.1.0
- [ejson](https://npm.io/package/ejson.md) 2.1.2
- [mongodb](https://npm.io/package/mongodb.md) 3.1.3
- [sqlite3](https://npm.io/package/sqlite3.md) 4.0.2
- [node-ssh](https://npm.io/package/node-ssh.md) 5.1.2
- [sequelize](https://npm.io/package/sequelize.md) 4.38.0
- [jsonschema](https://npm.io/package/jsonschema.md) 1.2.4
- [sequelizer](https://npm.io/package/sequelizer.md) 1.1.3
- [node-schedule](https://npm.io/package/node-schedule.md) 1.3.0
- [generate-schema](https://npm.io/package/generate-schema.md) 2.6.0

## Recent versions

- 0.0.6 (latest) — 2018-10-15
- 0.0.5 — 2018-10-11
- 0.0.4 — 2018-08-24
- 0.0.3 — 2018-08-23
- 0.0.2 — 2018-08-22
- 0.0.1 — 2018-08-22

## README

<h1 align="center">
  <img src="https://github.com/ingo-eichhorst/mojoin-core/blob/master/logo.png">
</h1>

[![npm version](https://badge.fury.io/js/mojoin-core.svg)](https://badge.fury.io/js/mojoin-core) [![CircleCI](https://circleci.com/gh/ingo-eichhorst/mojoin-core.svg?style=shield)](https://circleci.com/gh/ingo-eichhorst/mojoin-core) [![Coverage Status](https://coveralls.io/repos/github/ingo-eichhorst/mojoin-core/badge.svg?branch=master)](https://coveralls.io/github/ingo-eichhorst/mojoin-core?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/c46eb5d869004060bd33ccc8e4d137e2)](https://app.codacy.com/app/ingo-eichhorst/mojoin-core?utm_source=github.com&utm_medium=referral&utm_content=ingo-eichhorst/mojoin-core&utm_campaign=badger) [![Maintainability](https://api.codeclimate.com/v1/badges/2873d7c6e04b0f3524c2/maintainability)](https://codeclimate.com/github/ingo-eichhorst/mojoin-core/maintainability) [![Known Vulnerabilities](https://snyk.io/test/github/ingo-eichhorst/mojoin-core/badge.svg)](https://snyk.io/test/github/ingo-eichhorst/mojoin-core) [![JavaScript Style Guide: StandardJS](https://img.shields.io/badge/code%20style-StandardJS-brightgreen.svg?style=flat)](https://github.com/dwyl/goodparts "JavaScript The Good Parts") [![License: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://en.wikipedia.org/wiki/MIT_License) 

# mojoin-core

some general description goes here

## Quick Start

```Javascript
const Mojoin = require('mojoin-core')
const mojoin = new Mojoin([
  {
    name: 'todos',
    type: 'json',
    location: './node_modules/mojoin-core/examples/datasource/todos.json'
  },
  {
    name: 'users',
    type: 'rest',
    location: 'https://jsonplaceholder.typicode.com/users'
  }
])

const query = {
  table: 'todos',
  where: {
    userId: 2,
    completed: 0
  },
  include: [{
    model: 'users',
    foreignKey: 'userId'
  }]
}

mojoin.syncAll()
  .then(() => mojoin.generateReport(query))
  .then(r => console.log(r))
  .catch(e => console.error(e))
```

## Cache

### Default

### Specified

type: 'postgres' // 'mysql'|'sqlite'|'postgres'|'mssql',

## MongoDB

### Protocol: MongoDB

### Protocol: SSH

- privateKey
- password

---
_Source: https://npm.io/package/mojoin-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._