https://github.com/lykmapipo/mongoose-autoset

mongoose plugin to allow set referenced object id from instances(DEPRECATED)
https://github.com/lykmapipo/mongoose-autoset

mongodb mongoose mongoose-autoset mongoose-plugin objectid set

Last synced: about 2 months ago
JSON representation

mongoose plugin to allow set referenced object id from instances(DEPRECATED)

• Host: GitHub
• URL: https://github.com/lykmapipo/mongoose-autoset
• Owner: lykmapipo
• Created: 2017-01-21T15:27:07.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-09-14T18:17:21.000Z (over 6 years ago)
• Last Synced: 2024-04-24T13:28:01.123Z (8 months ago)
• Topics: mongodb, mongoose, mongoose-autoset, mongoose-plugin, objectid, set
• Language: JavaScript
• Homepage:
• Size: 27.3 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# mongoose-autoset(DEPRECATED)

[![Build Status](https://travis-ci.org/lykmapipo/mongoose-autoset.svg?branch=master)](https://travis-ci.org/lykmapipo/mongoose-autoset)

[![Dependency Status](https://img.shields.io/david/lykmapipo/mongoose-autoset.svg?style=flat)](https://david-dm.org/lykmapipo/mongoose-autoset)

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

mongoose plugin to allow set referenced object id from instances.

*Deprecation Notice: mongoose now support this feature out of box*

## Requirements

- NodeJS v6.5+

## Install

```sh

$ npm install --save mongoose mongoose-autoset

```

## Usage

```javascript

const mongoose = require('mongoose');

const Schema = mongoose.Schema;

//apply mongoose-autoset plugin to mongoose

mongoose.plugin(require('mongoose-autoset'));

...

const PersonSchema = new Schema({

    parent:{

        type: ObjectId,

        ref: 'Person',

        autoset: true  //will set id from instance._id i.e parent._id

    }

});

...

const parent = Person.findById(, );

const child = new Person({

	parent: parent, //no need to do parent._id

});

```

## Testing

* Clone this repository

* Install all development dependencies

```sh

$ npm install

```

* Then run test

```sh

$ npm test

```

## Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

## Licence

The MIT License (MIT)

Copyright (c) 2015 lykmapipo & Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.