mirror of
https://github.com/meteor/meteor.git
synced 2026-05-02 03:01:46 -04:00
4d861735c5
The change made ina30f42c4acswitched from CommonJS to ECMAScript export notation. It seems JSDoc isn't smart enough to make the same association as it did with the previous notation as it does for an anon. function expression `export`-ed as a `const`ant. We could annotate this with `@function check`, but it seems reasonable to just export a function declaration directly, which JSDoc will understand. This, along withababb18aef, corrects the failure of docs generation originally discovered in:8f7ceb5de5. Refs: https://github.com/meteor/meteor/pull/9593
check
Source code of released version | Source code of development version
check is a lightweight package for argument checking and general pattern matching. Use it like this:
Meteor.publish("chats-in-room", function (roomId) {
// Make sure roomId is a string, not an arbitrary mongo selector object.
check(roomId, String);
return Chats.find({room: roomId});
});
Meteor.methods({addChat: function (roomId, message) {
check(roomId, String);
check(message, {
text: String,
timestamp: Date,
// Optional, but if present must be an array of strings.
tags: Match.Optional([String])
});
// ... do something with the message ...
}});
For more details see the check section of the Meteor docs.