Ref

References between collections.

Install

meteor add shuttler:ref

Example

var b = new Mongo.Collection('a');
b.insert({ _id: 'c' });
var c = b.findOne('c');
c.Ref(); // { id: 'c', collection: 'a' }

Documentation

document.Ref(prefix?: String) => { id: String, collection: String }

Helper added to all documents in all the collections. Generates an object-reference to that document.

Arguments

prefix?: String

The optional arguments are appended prefix to the keys in result object-reference.

Example

c.Ref('_prefix'); // { '_prefix.id': 'c', '_prefix.collection': 'a' }

Shuttler.Ref(ref?: Object) => Document|undefined

Find and returns the document by reference, or undefined.

Shuttler.Ref.soft(ref?: Object) => Document|undefined

Like Shuttler.Ref, but if ref is a document returns it back.

Shuttler.Ref.new(ref?: Object|String, prefix?: String) => { id: String, collection?: String }

Generates an object-reference.

If arguments is wrong, thrown Meteor.Error('unexpected reference').

ref?: Object|String

• If ref is Document then uses ref.Ref(prefix).
• If ref is Ref then add prefix to the keys in ref.
• If ref is String then use ref as id field in Ref without collection field.

prefix?: String

The optional arguments are appended prefix to the keys in result object-reference.

Arguments

ref: Object

It must be a valid reference, else returns undefined.

Shuttler.isRef(ref?: Object) => Boolean

If ref is object with string id and optional string collection, then returns true.

Shuttler.Ref.Schema: SimpleSchema

Ready scheme for use with packages SimpleSchema and Collection2.

Versions

0.0.5

• Remove dependecie from dburles:mongo-collection-instances

0.0.1

• Shuttler.Ref.new
• collection field is optional
• Comments