marpat

v3.0.5

Published

3 years ago

A class-based ES6 ODM for Mongo-like databases.

Downloads

219

0High
0Medium
0Low

luidog

es6 odm mongodb nedb nosql document model schema database data datastore query db

marpat

Marpat is lightweight object modeling tool that uses ES6 classes to model data. This project is a fork of Camo. Marpat is designed to be a storage agnostic document collection backend. By default Marpat can connect to nedb, mongodb. Additionally, Marpat provides a Client Registry and DocumentClient class. The client registry and DocumentClient class can be used to use a custom backend.

Install and Run

To use Marpat, you must first have installed Node >=8.0.x, then run the following commands:

npm install marpat --save

And at least ONE of the following:

npm install nedb --save

OR

npm install mongodb --save

Quick Start

Marpat was built with ease-of-use and ES6 in mind, so you might notice it has more of an OOP feel to it than many existing libraries and ODMs. Don't worry, focusing on object-oriented design doesn't mean we forgot about functional techniques or asynchronous programming. Promises are built-in to the API. Just about every call you make interacting with the database (find, save, delete, etc) will return a Promise.

Connect to the Database

Before using any document methods, you must first connect to your underlying database. All supported databases have their own unique URI string used for connecting. The URI string usually describes the network location or file location of the database. However, some databases support more than just network or file locations. NeDB, for example, supports storing data in-memory, which can be specified to Marpat via nedb://memory. See below for details:

MongoDB:
- Format: mongodb://[username:password@]host[:port][/db-name]
- Example: const uri = 'mongodb://Ben:abc123@localhost:27017/animals';
NeDB:
- Format: nedb://[directory-path] OR nedb://memory
- Example: const uri = 'nedb://data';

So to connect to an NeDB database, use the following:

const { connect } = require('marpat')

const database;
const uri = 'nedb://data';
connect(uri).then(function(db) {
    database = db;
});

Creating A Model

All models must inherit from the Document class, which handles much of the interface to your backend NoSQL database.

const { Document } = require('marpat');

class Ghostbuster extends Document {
    constructor() {
        super();

        this.name = String;
        this.age = {
            type: Number,
            min: 0
        };
        this.employees = [String];
        this.dateFounded = {
            type: Date,
            default: Date.now
        };
        this.
    }

    static collectionName() {
        return 'companies';
    }
}

Notice how the schema is declared right in the constructor as member variables. All public member variables (variables that don't start with an underscore [_]) are added to the schema. The name of the collection can be set by overriding the static collectionName() method, which should return the desired collection name as a string. If one isn't given, then Marpat uses the name of the class and naively appends an 's' to the end to make it plural. Schemas can also be defined using the this.schema() method. For example, in the constructor() method you could use:

this.schema({
    name: String,
    valuation: {
        type: Number,
        default: 10000000000,
        min: 0
    },
    employees: [String],
    dateFounded: {
        type: Date,
        default: Date.now
    }
});

Currently supported variable types are:

String
Number
Boolean
Buffer
Date
Object
Array
EmbeddedDocument
Document Reference
Joi Schema

Arrays can either be declared as either un-typed (using Array or []), or typed (using the [TYPE] syntax, like [String]). Typed arrays are enforced by Marpat on .save() and an Error will be thrown if a value of the wrong type is saved in the array. Arrays of references are also supported.

To declare a member variable in the schema, either directly assign it one of the types listed above, or assign it an object with options, like this:

this.primeNumber = {
    type: Number,
    default: 2,
    validate: (value) => typeof value === "number"
    min: 0,
    max: 25,
    choices: [2, 3, 5, 7, 11, 13, 17, 19, 23],
    unique: true
};

The default option supports both values and no-argument functions (like Date.now). Currently the supported options are:

type: The value's type (required)
default: The value to be assigned if none is provided (optional)
min: The minimum value a Number can be (optional)
max: The maximum value a Number can be (optional)
choices: A list of possible values (optional)
match: A regex string that should match the value (optional)
validate: A 1-argument function that returns false if the value is invalid (optional)
private: A boolean indicating the member value should be removed by the toJSON method (optional)
unique: A boolean value indicating if a 'unique' index should be set (optional)
required: A boolean value indicating if a key value is required (optional)

To reference another document, just use its class name as the type.

class Dog extends Document {
    constructor() {
        super();

        this.name = String;
        this.breed = String;
    }
}

class Person extends Document {
    constructor() {
        super();

        this.pet = Dog;
        this.name = String;
        this.age = String;
    }

    static collectionName() {
        return 'people';
    }
}

Schema Declaration

Embedded Documents

Embedded documents can also be used within Documents. You must declare them separately from the main Document that it is being used in. EmbeddedDocuments are good for when you need an Object, but also need enforced schemas, validation, defaults, hooks, and member functions. All of the options (type, default, min, etc) mentioned above work on EmbeddedDocuments as well.

var { Document } = require('Marpat');
var { EmbeddedDocument } = require('Marpat');

class Money extends EmbeddedDocument {
    constructor() {
        super();

        this.value = {
            type: Number,
            choices: [1, 5, 10, 20, 50, 100]
        };

        this.currency = {
            type: String,
            default: 'usd'
        };
    }
}

class Wallet extends Document {
    constructor() {
        super();
        this.contents = [Money];
    }
}

const wallet = Wallet.create();
wallet.contents.push(Money.create());
wallet.contents[0].value = 5;
wallet.contents.push(Money.create());
wallet.contents[1].value = 100;

wallet.save().then(function() {
    console.log('Both Wallet and Money objects were saved!');
});

Creating and Saving

To create a new instance of our document, we need to use the .create() method, which handles all of the construction for us.

const lassie = Dog.create({
    name: 'Lassie',
    breed: 'Collie'
});

lassie.save().then(function(l) {
    console.log(l._id);
});

Once a document is saved, it will automatically be assigned a unique identifier by the backend database. This ID can be accessed by the ._id property.

If you specified a default value (or function) for a schema variable, that value will be assigned on creation of the object.

An alternative to .save() is .findOneAndUpdate(query, update, options). This static method will find and update (or insert) a document in one atomic operation (atomicity is guaranteed in MongoDB only). Using the {upsert: true} option will return a new document if one is not found with the given query.

Loading

Both the find and delete methods following closely (but not always exactly) to the MongoDB API, so it should feel fairly familiar.

If querying an object by id, you must use _id and not id.

To retrieve an object, you have a few methods available to you.

.findOne(query, options) (static method)
.find(query, options) (static method)

The .findOne() method will return the first document found, even if multiple documents match the query. .find() will return all documents matching the query. Each should be called as static methods on the document type you want to load.

Dog.findOne({ name: 'Lassie' }).then(function(l) {
    console.log('Got Lassie!');
    console.log('Her unique ID is', l._id);
});

.findOne() currently accepts the following option:

populate: Boolean value to load all or no references. Pass an array of field names to only populate the specified references
- Person.findOne({name: 'Billy'}, {populate: true}) populates all references in Person object
- Person.findOne({name: 'Billy'}, {populate: ['address', 'spouse']}) populates only 'address' and 'spouse' in Person object
- select: removes all properties from the returning data except those that match an array of values, or _id and _schema
- Person.findOne({}, {select: ['name']}) returns data with properties _id, _schema, and name.

.find() currently accepts the following options:

populate: Boolean value to load all or no references. Pass an array of field names to only populate the specified references
- Person.find({lastName: 'Smith'}, {populate: true}) populates all references in Person object
- Person.find({lastName: 'Smith'}, {populate: ['address', 'spouse']}) populates only 'address' and 'spouse' in Person object
sort: Sort the documents by the given field(s)
- Person.find({}, {sort: '-age'}) sorts by age in descending order
- Person.find({}, {sort: ['age', 'name']}) sorts by ascending age and then name, alphabetically
limit: Limits the number of documents returned
- Person.find({}, {limit: 5}) returns a maximum of 5 Person objects
skip: Skips the given number of documents and returns the rest
- Person.find({}, {skip: 5}) skips the first 5 Person objects and returns all others
select: removes all properties from the returning data except those that match an array of values, or _id and _schema
- Person.find({}, {select: ['name']}) returns data with properties _id, _schema, and name.

.findOneAndUpdate() currently accepts the following options:

populate: Boolean value to load all or no references.
- Person.findOneAndUpdate({name: 'Ben'},{name: 'Ben Danger'},{lastName: 'Smith'}, {populate: true}) populates all references in Person object
select: removes all properties from the returning data except those that match an array of values, or _id and _schema
- Person.findOneAndUpdate({name: 'Ben'},{name: 'Ben Danger'}, {select: ['name']}) returns data with properties _id, _schema, and name.

Deleting

To remove documents from the database, use one of the following:

.delete()
.deleteOne(query, options) (static method)
.deleteMany(query, options) (static method)
.findOneAndDelete(query, options) (static method)

The .delete() method should only be used on an instantiated document with a valid id. The other three methods should be used on the class of the document(s) you want to delete.

Dog.deleteMany({ breed: 'Collie' }).then(function(numDeleted) {
    console.log('Deleted', numDeleted, 'Collies from the database.');
});

Counting

To get the number of matching documents for a query without actually retrieving all of the data, use the .count() method.

Dog.count({ breed: 'Collie' }).then(function(count) {
    console.log('Found', count, 'Collies.');
});

Hooks

Marpat provides hooks for you to execute code before and after critical parts of your database interactions. For each hook you use, you may return a value (which, as of now, will be discarded) or a Promise for executing asynchronous code. Using Promises throughout Marpat allows us to not have to provide separate async and sync hooks, thus making your code simpler and easier to understand.

Hooks can be used not only on Document objects, but EmbeddedDocument objects as well. The embedded object's hooks will be called when it's parent Document is saved/validated/deleted (depending on the hook you provide).

In order to create a hook, you must override a class method. The hooks currently provided, and their corresponding methods, are:

pre-init: preInit(data)
pre-validate: preValidate()
post-validate: postValidate()
pre-save: preSave()
post-save: postSave()
pre-delete: preDelete()
post-delete: postDelete()
post-find: postFind()

Here is an example of using a hook (pre-delete, in this case):

class Company extends Document {
    constructor() {
        super();

        this.employees = [Person];
    }

    static collectionName() {
        return 'companies';
    }

    preDelete() {
        var deletes = [];
        this.employees.forEach(function(e) {
            var p = new Promise(function(resolve, reject) {
                resolve(e.delete());
            });

            deletes.push(p);
        });

        return Promise.all(deletes);
    }
}

The code above shows a pre-delete hook that deletes all the employees of the company before it itself is deleted. As you can see, this is much more convenient than needing to always remember to delete referenced employees in the application code.

Note: The .preDelete() and .postDelete() hooks are only called when calling .delete() on a Document instance. Calling .deleteOne() or .deleteMany() will not trigger the hook methods.

Custom Database Driver

Marpat provides two default database driver (NeDbClient and MongoDbClient). If you need to write you own database driver you can register it with the ClientRegistry service.

var { connect, ClientRegistry, DatabaseClient } = require('Marpat');

class MyClient extends DatabaseClient {
    static canHandle(url) {
        return url.indexOf('foo://') === 0;
    }
}

ClientRegistry.add(MyClient);

connect('foo://bar').then(function(db) { });

Misc.

Marpat.Client(): Retrieves the marpat database client
Marpat.Client().driver(): Retrieves the underlying database driver (MongoClient or a map of NeDB collections)
Document.toJSON(): Serializes the given document to just the data, which includes nested and referenced data

Transpiler Support

While many transpilers won't have any problem with Marpat, some need extra resources/plugins to work correctly:

Babel
- babel-preset-marpat: Babel preset for all es2015 plugins supported by marpat
TypeScript
- DefinitelyTyped/marpat: marpat declaration file (h/t lucasmciruzzi)
- IndefinitivelyTyped/marpat: Typings support for marpat (h/t WorldMaker)

Contributing

Feel free to open new issues or submit pull requests for Marpat. If you'd like to contact me before doing so, feel free to get in touch (see Contact section below).

Before opening an issue or submitting a PR, I ask that you follow these guidelines:

Issues

Please state whether your issue is a question, feature request, or bug report.
Always try the latest version of Marpat before opening an issue.
If the issue is a bug, be sure to clearly state your problem, what you expected to happen, and what all you have tried to resolve it.
Always try to post simplified code that shows the problem. Use Gists for longer examples.

Pull Requests

If your PR is a new feature, please consult with me first.
Any PR should contain only one feature or bug fix. If you have more than one, please submit them as separate PRs.
Always try to include relevant tests with your PRs. If you aren't sure where a test should go or how to create one, feel free to ask.
Include updates to the README when needed.

Tests

npm install
npm test

> [email protected] test /marpat
> snyk test && nyc _mocha --recursive ./test --timeout=30000 --exit


Testing /Users/luidelaparra/Documents/Development/marpat...

Organization:      luidog
Package manager:   npm
Target file:       package-lock.json
Project name:      marpat
Open source:       no
Project path:      /marpat
Local Snyk policy: found
Licenses:          enabled

✓ Tested 7 dependencies for known issues, no vulnerable paths found.

Next steps:
- Run `snyk monitor` to be notified about new related vulnerabilities.
- Run `snyk test` as part of your CI/test.



  Base Client
    Required Methods
      ✓ should require a (static) canHandle method
      ✓ should require a save method
      ✓ should require a delete method
      ✓ should require a delete method
      ✓ should require a deleteMany method
      ✓ should require a findOne method
      ✓ should require a findOneAndUpdate method
      ✓ should require a findOneAndDelete method
      ✓ should require a find method
      ✓ should require a find method
      ✓ should require a count method
      ✓ should require a createIndex method
      ✓ should require a (static) connect method
      ✓ should require a close method
      ✓ should require a clearCollection method
      ✓ should require a dropDatabase method
      ✓ should require a toCanonicalId method
      ✓ should require a isNativeId method
      ✓ should require a toNativeId method
      ✓ should require a nativeIdType method
      ✓ should require a driver method

  Base MongoDB Client
    #save()
      ✓ should reject if it can not update the object (147ms)
    #deleteMany()
      ✓ should reject if it can not delete the object
    #delete()
      ✓ should reject if it can not delete the object
    #deleteOne()
      ✓ should reject if it can not delete the object
    #findOne()
      ✓ should reject if it can not delete the object
    #dropDatabase()
      ✓ should reject if mongo rejects
    #count()
      ✓ should reject an invalid count query
    #findOneAndDelete()
      ✓ should reject an invalid findOneAndDelete query
      ✓ should return zero if no results are found
    #findOneAndupdate()
      ✓ should reject an invalid findOneAndUpdate query
      ✓ should return zero if no results are found
    #clearCollection()
      ✓ should reject an invalid findOneAndDelete query

  MongoDB Client
    #save()
      ✓ should persist the object and its members to the database (55ms)
    #findOne()
      ✓ should load a single object from the collection (68ms)
      ✓ should populate all fields (232ms)
      ✓ should not populate any fields (153ms)
      ✓ should populate specified fields (164ms)
      ✓ should select only the specified fields (180ms)
    #findOneAndUpdate()
      ✓ should return null if there is no document to update (57ms)
      ✓ should load and update a single object from the collection (69ms)
      ✓ should populate all fields (282ms)
      ✓ should not populate any fields (167ms)
      ✓ should return only the selected information (56ms)
      ✓ should insert a single object to the collection (178ms)
      ✓ requires at least two arguments (59ms)
    #findOneAndDelete()
      ✓ requires at least one argument (58ms)
      ✓ should load and delete a single object from the collection (58ms)
    #find()
      ✓ should load multiple objects from the collection
      ✓ should reject if mongo cursor rejects
      ✓ should load all objects when query is not provided
      ✓ should sort results in ascending order
      ✓ should sort results in descending order
      ✓ should sort results using multiple keys
      ✓ should sort results using multiple keys
      ✓ should limit number of results returned
      ✓ should skip given number of results
      ✓ should populate all fields (149ms)
      ✓ should not populate any fields (148ms)
      ✓ should populate specified fields (163ms)
      ✓ should select specified fields (154ms)
    #count()
      ✓ should return 0 objects from the collection (95ms)
      ✓ should disregard unsupported options (57ms)
      ✓ should return 2 matching objects from the collection (56ms)
    #delete()
      ✓ should remove instance from the collection (61ms)
      ✓ should return zero if there are no items to remove
    #deleteOne()
      ✓ should remove the object from the collection (52ms)
      ✓ should return zero if there are no items to remove
    #deleteMany()
      ✓ should remove multiple objects from the collection (59ms)
      ✓ should remove all objects when query is not provided (186ms)
    #clearCollection()
      ✓ should remove all objects from the collection (54ms)
    id
      ✓ should allow custom _id values (60ms)
    query
      ✓ should automatically cast string ID in query to ObjectID (56ms)
      ✓ should automatically cast string ID in query to ObjectID (81ms)
      ✓ should automatically cast string IDs in '$in' operator to ObjectIDs (57ms)
      ✓ should automatically cast string IDs in '$nin' operator to ObjectIDs (58ms)
      ✓ should automatically cast string IDs in '$not' operator to ObjectIDs (56ms)
      ✓ should automatically cast string IDs in deep query objects (54ms)
    indexes
      ✓ should reject documents with duplicate values in unique-indexed fields (103ms)
      ✓ should accept documents with duplicate values in non-unique-indexed fields (69ms)

  Base NeDB Client
    #save()
      ✓ should reject if it can not update the object
    #delete()
      ✓ should reject if it can not delete the object
      ✓ should reject if the nedb client throws an error
      ✓ should return 0 if the id is null
      ✓ should return 0 if the id is null
    #dropDatabase()
      ✓ should only remove Files if the are already there
    #count()
      ✓ should reject an invalid count query (82ms)
    #findOneAndDelete()
      ✓ should reject an invalid findOneAndDelete query
      ✓ should return zero if no results are found
    #findOneAndupdate()
      ✓ should reject an invalid findOneAndUpdate query
      ✓ should return zero if no results are found
    #clearCollection()
      ✓ should reject an invalid findOneAndDelete query

  NeDB In Memory Capabilities
    #save()
      ✓ should persist the object and its members to the database
    #findOne()
      ✓ should load a single object from the collection
      ✓ should populate all fields
      ✓ should not populate any fields
      ✓ should populate specified fields
      ✓ should select only the specified fields
    #findOneAndUpdate()
      ✓ should return null if there is no document to update
      ✓ should load and update a single object from the collection
      ✓ should populate all fields
      ✓ should not populate any fields
      ✓ should return only the selected information
      ✓ should insert a single object to the collection
      ✓ requires at least two arguments
    #findOneAndDelete()
      ✓ requires at least one argument
      ✓ should load and delete a single object from the collection
    #find()
      ✓ should load multiple objects from the collection
      ✓ should load all objects when query is not provided
      ✓ should sort results in ascending order
      ✓ should sort results in descending order
      ✓ should sort results using multiple keys
      ✓ should sort results using multiple keys
      ✓ should limit number of results returned
      ✓ should skip given number of results
      ✓ should populate all fields
      ✓ should not populate any fields
      ✓ should populate specified fields
      ✓ should select specified fields
    #count()
      ✓ should return 0 objects from the collection
      ✓ should disregard unsupported options
      ✓ should return 2 matching objects from the collection
    #delete()
      ✓ should remove instance from the collection
    #deleteOne()
      ✓ should remove the object from the collection
    #deleteMany()
      ✓ should remove multiple objects from the collection
      ✓ should remove all objects when query is not provided
    #clearCollection()
      ✓ should remove all objects from the collection

  NeDB File System Capabilities
    ✓ should create a file based store (42ms)
    ✓ should return collections as a driver (38ms)
    ✓ should remove files when used on the File System (42ms)
removed
    ✓ should not delete files if there are no collections (43ms)

  NeDbClient - old
    id
      ✓ should allow custom _id values
    indexes
      ✓ should reject documents with duplicate values in unique-indexed fields
      ✓ should accept documents with duplicate values in non-unique-indexed fields

  Client Registry
    #add
      ✓ should add a new client
      ✓ should return the given client
      ✓ should return the default client for nedb
      ✓ should return the default client for mongodb

  Connect Capability
    Ensure A Connection
      ✓ should throw an error if connect is not called
    Connect to stores
      ✓ should connect to an nedb connection
      ✓ should connect to a mongodb connection
      ✓ should reject if it can not connect to a mongodb connection (30006ms)
      ✓ should reject an unrecognized connection

  Base Document
    ✓ should throw an error if the static documentClass is not defined
    ✓ should throw an error if the documentClass is not defined

  Cyclical Dependencies
    schema
      ✓ should allow cyclic dependencies

  Document Capabilities
    instantiation
      ✓ should allow creation of instance
      ✓ should allow schema declaration via method
      ✓ should allow creation of instance with data
      ✓ should not create data that is not in the schema
      ✓ should not save data that is not in the schema data
      ✓ should allow creation of instance with references
    class
      ✓ should allow use of member variables in getters
      ✓ should allow use of member variables in setters
      ✓ should allow use of member variables in methods
      ✓ should allow schemas to be extended
      ✓ should allow schemas to be overridden
      ✓ should provide default collection name based on class name
      ✓ should provide default collection name based on subclass name
      ✓ should allow custom collection name
    types
      ✓ should allow reference types
      ✓ should allow array of references
      ✓ should allow references to be saved using the object or its id
      ✓ should allow array of references to be saved using the object or its id
      ✓ should allow circular references
      ✓ should allow string types
      ✓ should allow number types
      ✓ should allow boolean types
      ✓ should allow date types
      ✓ should allow object types
      ✓ should allow buffer types
      ✓ should allow array types
      ✓ should allow typed-array types
      ✓ should reject objects containing values with different types
      ✓ should reject typed-arrays containing different types
      ✓ should reject unsupported types
    defaults
      ✓ should assign default value if unassigned
      ✓ should assign default value via function if unassigned
      ✓ should be undefined if unassigned and no default is given
    choices
      ✓ should accept value specified in choices
      ✓ should reject values not specified in choices
    min
      ✓ should accept value > min
      ✓ should accept value == min
      ✓ should reject value < min
    max
      ✓ should accept value < max
      ✓ should accept value == max
      ✓ should reject value > max
    match
      ✓ should accept value matching regex
      ✓ should reject value not matching regex
    validate
      ✓ should accept value that passes custom validator
      ✓ should reject value that fails custom validator
    canonicalize
      ✓ should ensure timestamp dates are converted to Date objects
      ✓ should ensure date strings are converted to Date objects
    required
      ✓ should accept empty value that is not required
      ✓ should accept value that is not undefined
      ✓ should accept an empty value if default is specified
      ✓ should accept boolean value
      ✓ should accept date value
      ✓ should accept any number value
      ✓ should reject value that is undefined
      ✓ should reject value if specified default empty value
      ✓ should reject value that is null
      ✓ should reject value that is an empty array
      ✓ should reject value that is an empty string
      ✓ should reject value that is an empty object
    hooks
      ✓ should call all pre and post functions
      ✓ should call postFind when findOne is used
      ✓ should not call postFind when find is used
    serialize
      ✓ should serialize data to JSON
      ✓ should serialize data to JSON
      ✓ should serialize data to JSON
      ✓ should serialize data to JSON and ignore methods

  Embedded
    general
      ✓ should not have an _id
    types
      ✓ should allow embedded types
      ✓ should allow array of embedded types
      ✓ should save nested array of embeddeds
      ✓ should allow nested initialization of embedded types
      ✓ should allow initialization of array of embedded documents
    defaults
      ✓ should assign defaults to embedded types
      ✓ should assign defaults to array of embedded types
    validate
      ✓ should validate embedded values
      ✓ should accept a validation function
      ✓ should accept a validation function
      ✓ should accept an array of validation functions
      ✓ should validate array of embedded values
    canonicalize
      ✓ should ensure timestamp dates are converted to Date objects
    hooks
      ✓ should call all pre and post functions on embedded models
      ✓ should call all pre and post functions on array of embedded models
    serialize
      ✓ should serialize data to JSON
      ✓ should serialize data to JSON and ignore methods

  Issues
    #4
      ✓ should not load duplicate references in array when only one reference is present
    #5
      ✓ should allow multiple references to the same object in same array
    #8
      ✓ should use virtuals when initializing instance with data
    #20
      ✓ should not alias _id to id in queries and returned documents
    #43
      ✓ should save changes made in postValidate hook
      ✓ should save changes made in preSave hook
    #53
      ✓ should validate Array types properly
      ✓ should validate [] types properly
    #55
      ✓ should return updated data on findOneAndUpdate when updating nested data
    #57
      ✓ should not save due to Promise.reject in hook

  Utilities
    deepTraverse()
      ✓ should iterate over all keys nested in an object

  Validation Utility Tests
    ✓ should throw an error if the type is unsupported
    Type Detection
      ✓ should detect Arrays
      ✓ should detect Embedded Documents
      ✓ should reject undefined
      ✓ should reject null
    Supported Type Detection
      ✓ should support strings
      ✓ should support numbers
      ✓ should support object
      ✓ should support Arrays
      ✓ should support booleans
      ✓ should support Documents


  252 passing (50s)

-----------------------|---------|----------|---------|---------|----------------------------
File                   | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s          
-----------------------|---------|----------|---------|---------|----------------------------
All files              |      98 |    96.69 |   99.21 |   99.07 |                            
 marpat                |     100 |      100 |     100 |     100 |                            
  index.js             |     100 |      100 |     100 |     100 |                            
 marpat/lib            |    98.2 |    97.98 |   99.17 |   98.36 |                            
  base-document.js     |   96.68 |    95.78 |     100 |   96.67 | 291-314                    
  db.js                |     100 |      100 |     100 |     100 |                            
  document.js          |     100 |      100 |     100 |     100 |                            
  embedded-document.js |     100 |      100 |     100 |     100 |                            
  errors.js            |     100 |      100 |     100 |     100 |                            
  index.js             |     100 |      100 |     100 |     100 |                            
  util.js              |     100 |      100 |     100 |     100 |                            
  validate.js          |   98.72 |      100 |   94.44 |     100 |                            
 marpat/lib/clients    |   97.73 |    93.48 |   99.24 |     100 |                            
  client.js            |     100 |      100 |     100 |     100 |                            
  index.js             |     100 |      100 |     100 |     100 |                            
  mongoclient.js       |     100 |      100 |     100 |     100 |                            
  nedbclient.js        |      95 |    86.36 |   98.08 |     100 | 55,130-199,233,245,331,438 
  registry.js          |     100 |      100 |     100 |     100 |                            
-----------------------|---------|----------|---------|---------|----------------------------

Dependencies

@hapi/joi: Object schema validation
lodash: Lodash modular utilities.
mongodb: The official MongoDB driver for Node.js
nedb: File-based embedded data store for node.js

Dev Dependencies

chai: BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
chai-as-promised: Extends Chai with assertions about promises.
coveralls: takes json-cov output into stdin and POSTs to coveralls.io
eslint: An AST-based pattern checker for JavaScript.
eslint-config-google: ESLint shareable config for the Google style
eslint-config-prettier: Turns off all rules that are unnecessary or might conflict with Prettier.
eslint-plugin-prettier: Runs prettier as an eslint rule
faker: Generate massive amounts of fake contextual data
jsdocs: jsdocs
mocha: simple, flexible, fun test framework
mocha-lcov-reporter: LCOV reporter for Mocha
mos: A pluggable module that injects content into your markdown files via hidden JavaScript snippets
mos-plugin-execute: Mos plugin to inline a process output
nyc: the Istanbul command line interface
prettier: Prettier is an opinionated code formatter
proxyquire: Proxies nodejs require in order to allow overriding dependencies during testing.
sinon: JavaScript test spies, stubs and mocks.
snyk: snyk library and cli utility

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

marpat

Jump To

Install and Run

Quick Start

Connect to the Database

Creating A Model

Schema Declaration

Embedded Documents

Creating and Saving

Loading

Deleting

Counting

Hooks

Custom Database Driver

Misc.

Transpiler Support

Contributing

Tests

Dependencies

Dev Dependencies

License