@lykmapipo/mongoose-exportable

0.4.0 • Public • Published

mongoose-exportable

Build Status Dependencies Status Coverage Status GitHub License

Commitizen Friendly code style: prettier Code Style npm version

mongoose plugin to add aggregations behaviour.

Requirements

Install

$ npm install --save mongoose @lykmapipo/mongoose-exportable

Usage

import mongoose from 'mongoose';
import exportable from '@lykmapipo/mongoose-exportable';

const UserSchema = new Schema({ name: { type: String, exportable: true } });
UserSchema.plugin(exportable);
const User = mongoose.model('User', UserSchema);

// fs use 
const out = fs.createWriteStream('out.csv');
User.exportCsv().pipe(out);

// express use
app.get('/users/export', (request, response) => {
    response.attachment('out.csv');
    response.status(200);
    User.exportCsv().pipe(response);
});

Environment

NUMBER_MISSING_VALUE=0
STRING_MISSING_VALUE=NA

API

exportable(schema: Schema, [options: Object])

A exportable schema plugin. Once applied to a schema will compute exportable paths and add exportCsv model static function.

Example

const UserSchema = new Schema({ name: { type: String, exportable: true } });
UserSchema.plugin(exportable);
const User = mongoose.model('User', UserSchema);

exportCsv([optns: Object], [out: WritableStream], [cb: Function])

Create csv export readable stream.

Usage with fs:

const out = fs.createWriteStream('out.csv');
User.exportCsv().pipe(out);

Usage with express

app.get('/users/export', (request, response) => {
    response.attachment('out.csv');
    response.status(200);
    User.exportCsv().pipe(response);
});

Testing

  • Clone this repository

  • Install all development dependencies

$ npm install
  • Then run test
$ 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) 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.

Package Sidebar

Install

npm i @lykmapipo/mongoose-exportable

Weekly Downloads

21

Version

0.4.0

License

MIT

Unpacked Size

73 kB

Total Files

18

Last publish

Collaborators

  • lykmapipo