forked from meteor/meteor
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi-box.js
More file actions
187 lines (151 loc) · 4.89 KB
/
api-box.js
File metadata and controls
187 lines (151 loc) · 4.89 KB
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
var apiData = function (options) {
options = options || {};
if (typeof options === "string") {
options = {name: options};
}
var root = DocsData[options.name];
if (! root) {
console.log("API Data not found: " + options.name);
}
if (_.has(options, 'options')) {
root = _.clone(root);
var includedOptions = options.options.split(';');
root.options = _.filter(root.options, function (option) {
return _.contains(includedOptions, option.name);
});
}
return root;
};
var typeLink = function (displayName, url) {
return "<a href='" + url + "'>" + displayName + "</a>";
};
var toOrSentence = function (array) {
if (array.length === 1) {
return array[0];
} else if (array.length === 2) {
return array.join(" or ");
}
return _.initial(array).join(", ") + ", or " + _.last(array);
};
var typeNameTranslation = {
"function": "Function",
EJSON: typeLink("EJSON-able Object", "#ejson"),
EJSONable: typeLink("EJSON-able Object", "#ejson"),
"Tracker.Computation": typeLink("Tracker.Computation", "#tracker_computation"),
MongoSelector: [
typeLink("Mongo Selector", "#selectors"),
typeLink("Object ID", "#mongo_object_id"),
"String"
],
MongoModifier: typeLink("Mongo Modifier", "#modifiers"),
MongoSortSpecifier: typeLink("Mongo Sort Specifier", "#sortspecifiers"),
MongoFieldSpecifier: typeLink("Mongo Field Specifier", "#fieldspecifiers"),
JSONCompatible: "JSON-compatible Object",
EventMap: typeLink("Event Map", "#eventmaps"),
DOMNode: typeLink("DOM Node", "https://developer.mozilla.org/en-US/docs/Web/API/Node"),
"Blaze.View": typeLink("Blaze.View", "#blaze_view"),
Template: typeLink("Blaze.Template", "#blaze_template"),
DOMElement: typeLink("DOM Element", "https://developer.mozilla.org/en-US/docs/Web/API/element"),
MatchPattern: typeLink("Match Pattern", "#matchpatterns"),
"DDP.Connection": typeLink("DDP Connection", "#ddp_connect")
};
Template.autoApiBox.helpers({
apiData: apiData,
typeNames: function typeNames (nameList) {
// change names if necessary
nameList = _.map(nameList, function (name) {
// decode the "Array.<Type>" syntax
if (name.slice(0, 7) === "Array.<") {
// get the part inside angle brackets like in Array<String>
name = name.match(/<([^>]+)>/)[1];
if (name && typeNameTranslation.hasOwnProperty(name)) {
return "Array of " + typeNameTranslation[name] + "s";
}
if (name) {
return "Array of " + name + "s";
}
console.log("no array type defined");
return "Array";
}
if (typeNameTranslation.hasOwnProperty(name)) {
return typeNameTranslation[name];
}
if (DocsData[name]) {
return typeNames(DocsData[name].type);
}
return name;
});
nameList = _.flatten(nameList);
return toOrSentence(nameList);
},
signature: function () {
var signature;
var escapedLongname = _.escape(this.longname);
if (this.istemplate || this.ishelper) {
if (this.istemplate) {
signature = "{{> ";
} else {
signature = "{{ ";
}
signature += escapedLongname;
var params = this.params;
var paramNames = _.map(params, function (param) {
var name = param.name;
name = name + "=" + name;
if (param.optional) {
return "[" + name + "]";
}
return name;
});
signature += " " + paramNames.join(" ");
signature += " }}";
} else {
var beforeParens;
if (this.scope === "instance") {
beforeParens = "<em>" + apiData(this.memberof).instancename + "</em>." + this.name;
} else if (this.kind === "class") {
beforeParens = "new " + escapedLongname;
} else {
beforeParens = escapedLongname;
}
signature = beforeParens;
// if it is a function, and therefore has arguments
if (_.contains(["function", "class"], this.kind)) {
var params = this.params;
var paramNames = _.map(params, function (param) {
if (param.optional) {
return "[" + param.name + "]";
}
return param.name;
});
signature += "(" + paramNames.join(", ") + ")";
}
}
return signature;
},
id: function () {
if (Session.get("fullApi") && nameToId[this.longname]) {
return nameToId[this.longname];
}
// fallback
return this.longname.replace(/[.#]/g, "-");
},
paramsNoOptions: function () {
return _.reject(this.params, function (param) {
return param.name === "options";
});
},
fullApi: function () {
return Session.get("fullApi");
}
});
Template.apiBoxTitle.helpers({
link: function () {
return '#/' + (Session.get("fullApi") ? 'full' : 'basic') + '/' + this.id;
}
});
Template.autoApiBox.onRendered(function () {
this.$('pre code').each(function(i, block) {
hljs.highlightBlock(block);
});
});