# mongoose-service

> Model based wrapper for Mongoose

Latest version **1.0.1** (published 2022-11-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install mongoose-service
pnpm add mongoose-service
yarn add mongoose-service
bun add mongoose-service
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-11-29 |
| First published | 2022-11-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Maulik Pipaliya |
| Maintainers | maulikpipaliya |
| Keywords | Model, Service, Mongoose, MongoDB |

## Links

- npm: https://www.npmjs.com/package/mongoose-service
- Repository: https://github.com/maulikpipaliya/mongoose-service
- Homepage: https://github.com/maulikpipaliya/mongoose-service#readme
- Issues: https://github.com/maulikpipaliya/mongoose-service/issues
- npm.io page: https://npm.io/package/mongoose-service

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2022-11-29
- 1.0.0 — 2022-11-26

## README

# mongoose-service

> Model based wrapper for Mongoose

## Installation

```sh
npm install mongoose-service
```

## Usage

```js
const mongoose = require("mongoose");
const MongooseService = require("mongoose-service");

const schema = new mongoose.Schema({
  /* schema definition */
});
const schemaModel = mongoose.model("MySchema", schema);
const schemaService = new MongooseService(schemaModel);
```

### MongooseService(schemaModel)

**Parameters**

- `schemaModel` {mongoose.model} - Mongoose Model

**Common Options where applicable**

- `find` {Object} - Filter object for Mongoose
- `select` {String | Object} - Projection
- `sort` {Object} - Mongoose Sort Object
- `skip` {Number} - Documents to skip
- `limit` {Number} - Limit number of documents to receive
- `populate` {String | Object} - Only if specified or default `page`/`offset` values were used

### Examples

#### Create a document

```js
await schemaService.create({ name: "Joyy", age: 25, city: "ST" });
```

#### Get a single document

```js
await schemaService.get({ find: { name: "Joyy", select: "name" } });
```

#### List all documents

```js
await schemaService.list({ find: { age: { $gt: 20 } }, select: "name", limit: 10 });
```

#### Update document (many or one at once)

```js
// update single record
await schemaService.update({ name: "Joyy" }, { $set: "Maulik" });

// update many at once
const updateMany = true;
await schemaService.update(
  {
    city: "ST",
  },
  {
    $set: "Surat",
  },
  updateMany
);
```

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