# mongoose-query-random

> Pull out random documents from a collection using Mongoose.

Latest version **1.0.1** (published 2016-01-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install mongoose-query-random
pnpm add mongoose-query-random
yarn add mongoose-query-random
bun add mongoose-query-random
```

## 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 | 2016-01-12 |
| First published | 2016-01-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Zachary Sloss |
| Maintainers | zsloss |
| Keywords | mongoose, mongo, mongodb, random, query, documents, unique |

## Links

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

## Dependencies (1)

- [random-int-array](https://npm.io/package/random-int-array.md) ^1.0.0

## 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) — 2016-01-12
- 1.0.0 — 2016-01-12

## README

# mongoose-query-random

Pull out random documents from a collection using Mongoose.

## Node.js Installation

```
$ npm install mongoose-query-random
```

## Usage

```javascript
require('mongoose-query-random');

query.random(count, unique, callback);
```
To return documents no more than once, set `unique` to `true`.

### Examples

```javascript
require('mongoose-query-random');

Cat.find().random(5, true, function(err, cats) {
    if (err) throw err;
    console.log(cats);
});

Users.find().where('name').equals('Anna').random(1, false, function(err, annas) {
    if (err) throw err;
    console.log(annas);
});
```

## Performance Note

This module performs as well as `mongodb`'s `cursor.skip()`, multiplied by the specified `count` (it needs to `skip` for *each document* it pulls out). So very large queries with a large count might take a while to execute.

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