# waterline-model-loader

> Load Waterline models from a directory

Latest version **0.2.8** (published 2017-04-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install waterline-model-loader
pnpm add waterline-model-loader
yarn add waterline-model-loader
bun add waterline-model-loader
```

## 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.2.8 |
| Published | 2017-04-26 |
| First published | 2016-02-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Arjan Frans |
| Maintainers | arjanfrans |

## Links

- npm: https://www.npmjs.com/package/waterline-model-loader
- Repository: https://github.com/arjanfrans/waterline-model-loader
- Homepage: https://github.com/arjanfrans/waterline-model-loader#readme
- Issues: https://github.com/arjanfrans/waterline-model-loader/issues
- npm.io page: https://npm.io/package/waterline-model-loader

## Dependencies (2)

- [waterline](https://npm.io/package/waterline.md) ^0.11.11
- [recursive-readdir](https://npm.io/package/recursive-readdir.md) ^2.1.1

## Recent versions

- 0.2.8 (latest) — 2017-04-26
- 0.2.7 — 2017-04-26
- 0.2.6 — 2017-04-26
- 0.2.5 — 2017-04-16
- 0.2.4 — 2016-11-04
- 0.2.3 — 2016-11-04
- 0.2.2 — 2016-10-28
- 0.2.1 — 2016-10-02
- 0.2.0 — 2016-06-16
- 0.1.9 — 2016-04-27
- 0.1.8 — 2016-04-25
- 0.1.7 — 2016-03-29
- 0.1.6 — 2016-02-25
- 0.1.5 — 2016-02-24
- 0.1.4 — 2016-02-24
- … 4 more at https://npm.io/package/waterline-model-loader/versions

## README

# Waterline model loader

[![npm version](https://img.shields.io/npm/v/waterline-model-loader.svg)](https://www.npmjs.com/package/waterline-model-loader)
[![Build Status](https://travis-ci.org/arjanfrans/waterline-model-loader.svg?branch=master)](https://travis-ci.org/arjanfrans/waterline-model-loader)
[![Coverage Status](https://coveralls.io/repos/arjanfrans/waterline-model-loader/badge.svg)](https://coveralls.io/r/arjanfrans/waterline-model-loader)
[![Dependency Status](https://david-dm.org/arjanfrans/waterline-model-loader.svg)](https://david-dm.org/arjanfrans/waterline-model-loader)
[![devDependency Status](https://david-dm.org/arjanfrans/waterline-model-loader/dev-status.svg)](https://david-dm.org/arjanfrans/waterline-model-loader#info=devDependencies)

Node module to load Waterline models from a directory and use the file names (without the extension)
for the model names. It is an abstraction on the Waterline loading process.

## Installation

```
npm install --save waterline-model-loader
```

## Basic usage

Create a directory where your models live. The files are loaded recursively, however the name of
the model files must be unique.

Model example:
```javascript
// ./models/Example.js

// A regular Waterline model
module.exports = {
    attributes: {
        name: {
            type: 'string',
            required: true
        }
    }
};
```

Usage example:
```javascript
const path = require('path');
const modelLoader = require('waterline-model-loader').default;

let config = {
    modelsDir: path.join(__dirname, './models'),
    connections: {
        // Waterline connections object
    }
};

modelLoader.setup(config).then(models => {
    // do stuff with your Waterline models
    let ExampleModel = models.Example;

    // do stuff with ExampleModel
}).catch(err => {
    // deal with any setup errors
});

// Alternatively you can access the models from the modelLoader singleton after setup:
// let models = modelLoader.models;


// When quiting your app you can teardown the connections.
// This could be necessary for tests if multiple connections are loaded.
modelLoader.teardown().then(() => {
    console.log('done');
}).catch(err => {
    // deal with an error (and report it if you suspect a bug)
})

```

See the [Waterline docs](https://github.com/balderdashy/waterline-docs) for a *connections* object
or check the tests for an [example](./test/connections.js).

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