https://github.com/dburles/meteor-collection-helpers

⚙️ Meteor package that allows you to define helpers on your collections
https://github.com/dburles/meteor-collection-helpers

meteor meteor-package

Last synced: about 2 months ago
JSON representation

⚙️ Meteor package that allows you to define helpers on your collections

• Host: GitHub
• URL: https://github.com/dburles/meteor-collection-helpers
• Owner: dburles
• License: mit
• Created: 2013-12-31T06:25:24.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-09-27T20:33:28.000Z (almost 7 years ago)
• Last Synced: 2024-01-30T06:54:21.907Z (5 months ago)
• Topics: meteor, meteor-package
• Language: JavaScript
• Homepage: https://atmospherejs.com/dburles/collection-helpers
• Size: 67.4 KB
• Stars: 497
• Watchers: 18
• Forks: 30
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• awesome-meteor - dburles:collection-helpers
• awesome-stars - meteor-collection-helpers

README

        
# Meteor Collection Helpers

Collection helpers automatically sets up a transformation on your collections using Meteor's Mongo.Collection `transform` option, allowing for simple models with an interface that's similar to template helpers.

## Installation

```sh

$ meteor add dburles:collection-helpers

```

## Usage

Write your helpers somewhere seen by both client and server.

```javascript

Books = new Mongo.Collection('books');

Authors = new Mongo.Collection('authors');

Books.helpers({

  author() {

    return Authors.findOne(this.authorId);

  }

});

Authors.helpers({

  fullName() {

    return `${this.firstName} ${this.lastName}`;

  },

  books() {

    return Books.find({ authorId: this._id });

  }

});

```

This will then allow you to do:

```javascript

Books.findOne().author().firstName; // Charles

Books.findOne().author().fullName(); // Charles Darwin

Authors.findOne().books()

```

Our relationships are resolved by the collection helper, avoiding unnecessary template helpers. So we can simply write:

```javascript

Template.books.helpers({

  books() {

    return Books.find();

  }

});

```

...with the corresponding template:

```html

  


    {{#each books}}

      
{{name}} by {{author.fullName}}

    {{/each}}

  


```

## Meteor.users

You can also apply helpers to the Meteor.users collection

```javascript

Meteor.users.helpers({

  // ...

});

```

### Applying the transformation function

Sometimes it may be useful to apply the transformation directly to an object.

```js

var doc = {

  firstName: 'Charles',

  lastName: 'Darwin'

};

var transformedDoc = Authors._transform(doc);

transformedDoc.fullName(); // Charles Darwin

```

### License

MIT