summaryrefslogtreecommitdiff
path: root/node_modules/mongoose/docs/methods-statics.md
blob: 27b5902387afb47df8f7e2a3f0f438dc00a16cc6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
Methods and Statics
====================

Each `Schema` can define instance and static methods for its model.

## Methods

Methods are easy to define:

    var AnimalSchema = new Schema({
        name: String
      , type: String
    });

    AnimalSchema.methods.findSimilarType = function findSimilarType (cb) {
      return this.find({ type: this.type }, cb);
    };

Now when we have an instance of `Animal` we can call our `findSimilarType` method and
find all animals with a matching `type`.

    var Animal = mongoose.model('Animal', AnimalSchema);
    var dog = new Animal({ name: 'Rover', type: 'dog' });

    dog.findSimilarType(function (err, dogs) {
      if (err) return ...
      dogs.forEach(..);
    })

Note that we return what `.find()` returns in our method. The advantages are two-fold.
First, by passing `cb` into `find` we are making it optional b/c `find` called
without a callback will not run the query. Secondly, `this.find`, `this.where`,
and other Model methods return instances of [Query](/docs/finding-documents.html)
which allow us to further utilize its expressive capabilities.

    dog
    .findSimilarType()
    .where('name': /rover/i)
    .limit(20)
    .run(function (err, rovers) {
      if (err) ...
    })

## Statics

Statics are pretty much the same as methods but allow for defining functions that
exist directly on your Model.

    AnimalSchema.statics.search = function search (name, cb) {
      return this.where('name', new RegExp(name, 'i')).run(cb);
    }

    Animal.search('Rover', function (err) {
      if (err) ...
    })