filehound 2.0.0-beta.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (212) hide show
  1. package/README.md +39 -11
  2. package/dist/arrays.d.ts +1 -0
  3. package/dist/arrays.js +4 -0
  4. package/dist/file.d.ts +108 -0
  5. package/dist/file.js +184 -0
  6. package/dist/filehound.d.ts +356 -0
  7. package/dist/filehound.js +498 -0
  8. package/dist/files.d.ts +4 -0
  9. package/dist/files.js +37 -0
  10. package/dist/filetype.d.ts +10 -0
  11. package/dist/filetype.js +9 -0
  12. package/dist/index.d.ts +5 -0
  13. package/dist/index.js +6 -0
  14. package/dist/matchers.d.ts +324 -0
  15. package/dist/matchers.js +419 -0
  16. package/dist/walker/async.d.ts +4 -0
  17. package/dist/walker/async.js +237 -0
  18. package/dist/walker/heap.d.ts +7 -0
  19. package/dist/walker/heap.js +49 -0
  20. package/dist/walker/sync.d.ts +4 -0
  21. package/dist/walker/sync.js +66 -0
  22. package/dist/walker/walk.d.ts +33 -0
  23. package/dist/walker/walk.js +80 -0
  24. package/package.json +45 -48
  25. package/.github/stale.yml +0 -42
  26. package/.travis.yml +0 -8
  27. package/.vscode/launch.json +0 -21
  28. package/.vscode/settings.json +0 -3
  29. package/CONTRIBUTING.md +0 -8
  30. package/_config.yml +0 -1
  31. package/coverage/coverage.raw.json +0 -1
  32. package/coverage/lcov-report/arrays.ts.html +0 -98
  33. package/coverage/lcov-report/base.css +0 -212
  34. package/coverage/lcov-report/filehound.ts.html +0 -2078
  35. package/coverage/lcov-report/files.ts.html +0 -260
  36. package/coverage/lcov-report/functions.ts.html +0 -122
  37. package/coverage/lcov-report/index.html +0 -132
  38. package/coverage/lcov-report/prettify.css +0 -1
  39. package/coverage/lcov-report/prettify.js +0 -1
  40. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  41. package/coverage/lcov-report/sorter.js +0 -158
  42. package/coverage/lcov.info +0 -378
  43. package/dist/src/arrays.js +0 -15
  44. package/dist/src/arrays.js.map +0 -1
  45. package/dist/src/asyncWalker.js +0 -59
  46. package/dist/src/asyncWalker.js.map +0 -1
  47. package/dist/src/bind.js +0 -15
  48. package/dist/src/bind.js.map +0 -1
  49. package/dist/src/filehound.js +0 -597
  50. package/dist/src/filehound.js.map +0 -1
  51. package/dist/src/files.js +0 -60
  52. package/dist/src/files.js.map +0 -1
  53. package/dist/src/matcher.js +0 -51
  54. package/dist/src/matcher.js.map +0 -1
  55. package/dist/src/syncWalker.js +0 -47
  56. package/dist/src/syncWalker.js.map +0 -1
  57. package/dist/src/walkAsync.js +0 -33
  58. package/dist/src/walkAsync.js.map +0 -1
  59. package/dist/src/walkSync.js +0 -21
  60. package/dist/src/walkSync.js.map +0 -1
  61. package/dist/src/walker/walk.js +0 -68
  62. package/dist/src/walker/walk.js.map +0 -1
  63. package/dist/src/walker/walkAsync.js +0 -33
  64. package/dist/src/walker/walkAsync.js.map +0 -1
  65. package/dist/src/walker/walkSync.js +0 -21
  66. package/dist/src/walker/walkSync.js.map +0 -1
  67. package/dist/test/filehound.js +0 -872
  68. package/dist/test/filehound.js.map +0 -1
  69. package/dist/test/files.js +0 -29
  70. package/dist/test/files.js.map +0 -1
  71. package/docconfig/jsdoc.json +0 -26
  72. package/docconfig/template/LICENSE +0 -61
  73. package/docconfig/template/README.md +0 -86
  74. package/docconfig/template/package.json +0 -22
  75. package/docconfig/template/publish.js +0 -676
  76. package/docconfig/template/static/fonts/OpenSans-Bold-webfont.eot +0 -0
  77. package/docconfig/template/static/fonts/OpenSans-Bold-webfont.svg +0 -1830
  78. package/docconfig/template/static/fonts/OpenSans-Bold-webfont.woff +0 -0
  79. package/docconfig/template/static/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  80. package/docconfig/template/static/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
  81. package/docconfig/template/static/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  82. package/docconfig/template/static/fonts/OpenSans-Italic-webfont.eot +0 -0
  83. package/docconfig/template/static/fonts/OpenSans-Italic-webfont.svg +0 -1830
  84. package/docconfig/template/static/fonts/OpenSans-Italic-webfont.woff +0 -0
  85. package/docconfig/template/static/fonts/OpenSans-Light-webfont.eot +0 -0
  86. package/docconfig/template/static/fonts/OpenSans-Light-webfont.svg +0 -1831
  87. package/docconfig/template/static/fonts/OpenSans-Light-webfont.woff +0 -0
  88. package/docconfig/template/static/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  89. package/docconfig/template/static/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
  90. package/docconfig/template/static/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  91. package/docconfig/template/static/fonts/OpenSans-Regular-webfont.eot +0 -0
  92. package/docconfig/template/static/fonts/OpenSans-Regular-webfont.svg +0 -1831
  93. package/docconfig/template/static/fonts/OpenSans-Regular-webfont.woff +0 -0
  94. package/docconfig/template/static/fonts/OpenSans-Semibold-webfont.eot +0 -0
  95. package/docconfig/template/static/fonts/OpenSans-Semibold-webfont.svg +0 -1830
  96. package/docconfig/template/static/fonts/OpenSans-Semibold-webfont.ttf +0 -0
  97. package/docconfig/template/static/fonts/OpenSans-Semibold-webfont.woff +0 -0
  98. package/docconfig/template/static/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
  99. package/docconfig/template/static/fonts/OpenSans-SemiboldItalic-webfont.svg +0 -1830
  100. package/docconfig/template/static/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
  101. package/docconfig/template/static/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
  102. package/docconfig/template/static/scripts/linenumber.js +0 -25
  103. package/docconfig/template/static/scripts/prettify/Apache-License-2.0.txt +0 -202
  104. package/docconfig/template/static/scripts/prettify/lang-css.js +0 -2
  105. package/docconfig/template/static/scripts/prettify/prettify.js +0 -28
  106. package/docconfig/template/static/styles/jsdoc-default.css +0 -605
  107. package/docconfig/template/static/styles/prettify-jsdoc.css +0 -111
  108. package/docconfig/template/static/styles/prettify-tomorrow.css +0 -132
  109. package/docconfig/template/tmpl/augments.tmpl +0 -10
  110. package/docconfig/template/tmpl/container.tmpl +0 -183
  111. package/docconfig/template/tmpl/details.tmpl +0 -143
  112. package/docconfig/template/tmpl/example.tmpl +0 -2
  113. package/docconfig/template/tmpl/examples.tmpl +0 -13
  114. package/docconfig/template/tmpl/exceptions.tmpl +0 -32
  115. package/docconfig/template/tmpl/layout.tmpl +0 -47
  116. package/docconfig/template/tmpl/mainpage.tmpl +0 -10
  117. package/docconfig/template/tmpl/members.tmpl +0 -38
  118. package/docconfig/template/tmpl/method.tmpl +0 -105
  119. package/docconfig/template/tmpl/params.tmpl +0 -124
  120. package/docconfig/template/tmpl/properties.tmpl +0 -108
  121. package/docconfig/template/tmpl/returns.tmpl +0 -19
  122. package/docconfig/template/tmpl/source.tmpl +0 -8
  123. package/docconfig/template/tmpl/tutorial.tmpl +0 -19
  124. package/docconfig/template/tmpl/type.tmpl +0 -7
  125. package/docs/FileHound.html +0 -3079
  126. package/docs/FileHound_modified.html +0 -245
  127. package/docs/_config.yml +0 -1
  128. package/docs/filehound.js.html +0 -697
  129. package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
  130. package/docs/fonts/OpenSans-Bold-webfont.svg +0 -1830
  131. package/docs/fonts/OpenSans-Bold-webfont.woff +0 -0
  132. package/docs/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  133. package/docs/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
  134. package/docs/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  135. package/docs/fonts/OpenSans-Italic-webfont.eot +0 -0
  136. package/docs/fonts/OpenSans-Italic-webfont.svg +0 -1830
  137. package/docs/fonts/OpenSans-Italic-webfont.woff +0 -0
  138. package/docs/fonts/OpenSans-Light-webfont.eot +0 -0
  139. package/docs/fonts/OpenSans-Light-webfont.svg +0 -1831
  140. package/docs/fonts/OpenSans-Light-webfont.woff +0 -0
  141. package/docs/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  142. package/docs/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
  143. package/docs/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  144. package/docs/fonts/OpenSans-Regular-webfont.eot +0 -0
  145. package/docs/fonts/OpenSans-Regular-webfont.svg +0 -1831
  146. package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
  147. package/docs/fonts/OpenSans-Semibold-webfont.eot +0 -0
  148. package/docs/fonts/OpenSans-Semibold-webfont.svg +0 -1830
  149. package/docs/fonts/OpenSans-Semibold-webfont.ttf +0 -0
  150. package/docs/fonts/OpenSans-Semibold-webfont.woff +0 -0
  151. package/docs/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
  152. package/docs/fonts/OpenSans-SemiboldItalic-webfont.svg +0 -1830
  153. package/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
  154. package/docs/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
  155. package/docs/global.html +0 -288
  156. package/docs/index.html +0 -154
  157. package/docs/scripts/linenumber.js +0 -25
  158. package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
  159. package/docs/scripts/prettify/lang-css.js +0 -2
  160. package/docs/scripts/prettify/prettify.js +0 -28
  161. package/docs/styles/jsdoc-default.css +0 -605
  162. package/docs/styles/prettify-jsdoc.css +0 -111
  163. package/docs/styles/prettify-tomorrow.css +0 -132
  164. package/docs.md +0 -164
  165. package/index.js +0 -1
  166. package/issue_template.md +0 -6
  167. package/test/filehound.ts +0 -1076
  168. package/test/files.ts +0 -29
  169. package/test/fixtures/custom/failed.txt +0 -0
  170. package/test/fixtures/custom/passed.txt +0 -0
  171. package/test/fixtures/deeplyNested/c.json +0 -0
  172. package/test/fixtures/deeplyNested/d.json +0 -0
  173. package/test/fixtures/deeplyNested/mydir/e.json +0 -0
  174. package/test/fixtures/deeplyNested/mydir/mydir2/f.json +0 -0
  175. package/test/fixtures/deeplyNested/mydir/mydir2/mydir3/mydir4/failed.json +0 -0
  176. package/test/fixtures/deeplyNested/mydir/mydir2/mydir3/z.json +0 -0
  177. package/test/fixtures/deeplyNested/mydir/mydir2/y.json +0 -0
  178. package/test/fixtures/deeplyNestedWithHiddenDir/c.json +0 -0
  179. package/test/fixtures/deeplyNestedWithHiddenDir/d.json +0 -0
  180. package/test/fixtures/deeplyNestedWithHiddenDir/mydir/e.json +0 -0
  181. package/test/fixtures/deeplyNestedWithHiddenDir/mydir/mydir2/f.json +0 -0
  182. package/test/fixtures/deeplyNestedWithHiddenDir/mydir/mydir2/mydir3/mydir4/.mydir5/.keep +0 -0
  183. package/test/fixtures/deeplyNestedWithHiddenDir/mydir/mydir2/mydir3/mydir4/failed.json +0 -0
  184. package/test/fixtures/deeplyNestedWithHiddenDir/mydir/mydir2/mydir3/z.json +0 -0
  185. package/test/fixtures/deeplyNestedWithHiddenDir/mydir/mydir2/y.json +0 -0
  186. package/test/fixtures/ext/Dummy.java +0 -0
  187. package/test/fixtures/ext/Dumpy.go +0 -0
  188. package/test/fixtures/ext/dummy.json +0 -0
  189. package/test/fixtures/ext/dummy.txt +0 -0
  190. package/test/fixtures/justFiles/a.json +0 -0
  191. package/test/fixtures/justFiles/b.json +0 -0
  192. package/test/fixtures/justFiles/dummy.txt +0 -0
  193. package/test/fixtures/mixed/a.json +0 -0
  194. package/test/fixtures/mixed/aabbcc.json +0 -0
  195. package/test/fixtures/mixed/ab.json +0 -0
  196. package/test/fixtures/mixed/z.json +0 -0
  197. package/test/fixtures/nested/.hidden1/bad.txt +0 -0
  198. package/test/fixtures/nested/c.json +0 -0
  199. package/test/fixtures/nested/d.json +0 -0
  200. package/test/fixtures/nested/mydir/e.json +0 -0
  201. package/test/fixtures/sizes/10b.txt +0 -0
  202. package/test/fixtures/sizes/1b.txt +0 -0
  203. package/test/fixtures/sizes/1k.txt +0 -0
  204. package/test/fixtures/sizes/2k.txt +0 -0
  205. package/test/fixtures/visibility/.hidden/.hidden.json +0 -0
  206. package/test/fixtures/visibility/.hidden/visible.json +0 -3
  207. package/test/fixtures/visibility/.hidden.json +0 -3
  208. package/test/fixtures/visibility/visible/.hidden.json +0 -3
  209. package/test/fixtures/visibility/visible.json +0 -3
  210. package/test/mocha.opts +0 -4
  211. package/tsconfig.json +0 -16
  212. package/tslint.json +0 -44
@@ -1,132 +0,0 @@
1
- /* Tomorrow Theme */
2
- /* Original theme - https://github.com/chriskempson/tomorrow-theme */
3
- /* Pretty printing styles. Used with prettify.js. */
4
- /* SPAN elements with the classes below are added by prettyprint. */
5
- /* plain text */
6
- .pln {
7
- color: #4d4d4c; }
8
-
9
- @media screen {
10
- /* string content */
11
- .str {
12
- color: hsl(104, 100%, 24%); }
13
-
14
- /* a keyword */
15
- .kwd {
16
- color: hsl(240, 100%, 50%); }
17
-
18
- /* a comment */
19
- .com {
20
- color: hsl(0, 0%, 60%); }
21
-
22
- /* a type name */
23
- .typ {
24
- color: hsl(240, 100%, 32%); }
25
-
26
- /* a literal value */
27
- .lit {
28
- color: hsl(240, 100%, 40%); }
29
-
30
- /* punctuation */
31
- .pun {
32
- color: #000000; }
33
-
34
- /* lisp open bracket */
35
- .opn {
36
- color: #000000; }
37
-
38
- /* lisp close bracket */
39
- .clo {
40
- color: #000000; }
41
-
42
- /* a markup tag name */
43
- .tag {
44
- color: #c82829; }
45
-
46
- /* a markup attribute name */
47
- .atn {
48
- color: #f5871f; }
49
-
50
- /* a markup attribute value */
51
- .atv {
52
- color: #3e999f; }
53
-
54
- /* a declaration */
55
- .dec {
56
- color: #f5871f; }
57
-
58
- /* a variable name */
59
- .var {
60
- color: #c82829; }
61
-
62
- /* a function name */
63
- .fun {
64
- color: #4271ae; } }
65
- /* Use higher contrast and text-weight for printable form. */
66
- @media print, projection {
67
- .str {
68
- color: #060; }
69
-
70
- .kwd {
71
- color: #006;
72
- font-weight: bold; }
73
-
74
- .com {
75
- color: #600;
76
- font-style: italic; }
77
-
78
- .typ {
79
- color: #404;
80
- font-weight: bold; }
81
-
82
- .lit {
83
- color: #044; }
84
-
85
- .pun, .opn, .clo {
86
- color: #440; }
87
-
88
- .tag {
89
- color: #006;
90
- font-weight: bold; }
91
-
92
- .atn {
93
- color: #404; }
94
-
95
- .atv {
96
- color: #060; } }
97
- /* Style */
98
- /*
99
- pre.prettyprint {
100
- background: white;
101
- font-family: Consolas, Monaco, 'Andale Mono', monospace;
102
- font-size: 12px;
103
- line-height: 1.5;
104
- border: 1px solid #ccc;
105
- padding: 10px; }
106
- */
107
-
108
- /* Specify class=linenums on a pre to get line numbering */
109
- ol.linenums {
110
- margin-top: 0;
111
- margin-bottom: 0; }
112
-
113
- /* IE indents via margin-left */
114
- li.L0,
115
- li.L1,
116
- li.L2,
117
- li.L3,
118
- li.L4,
119
- li.L5,
120
- li.L6,
121
- li.L7,
122
- li.L8,
123
- li.L9 {
124
- /* */ }
125
-
126
- /* Alternate shading for lines */
127
- li.L1,
128
- li.L3,
129
- li.L5,
130
- li.L7,
131
- li.L9 {
132
- /* */ }
@@ -1,10 +0,0 @@
1
- <?js
2
- var data = obj;
3
- var self = this;
4
- ?>
5
-
6
- <?js if (data.augments && data.augments.length) { ?>
7
- <ul><?js data.augments.forEach(function(a) { ?>
8
- <li><?js= self.linkto(a, a) ?></li>
9
- <?js }) ?></ul>
10
- <?js } ?>
@@ -1,183 +0,0 @@
1
- <?js
2
- var self = this;
3
- var isGlobalPage;
4
-
5
- docs.forEach(function(doc, i) {
6
- ?>
7
-
8
- <?js
9
- // we only need to check this once
10
- if (typeof isGlobalPage === 'undefined') {
11
- isGlobalPage = (doc.kind === 'globalobj');
12
- }
13
- ?>
14
- <?js if (doc.kind === 'mainpage' || (doc.kind === 'package')) { ?>
15
- <?js= self.partial('mainpage.tmpl', doc) ?>
16
- <?js } else if (doc.kind === 'source') { ?>
17
- <?js= self.partial('source.tmpl', doc) ?>
18
- <?js } else { ?>
19
-
20
- <section>
21
-
22
- <header>
23
- <?js if (!doc.longname || doc.kind !== 'module') { ?>
24
- <h2><?js if (doc.ancestors && doc.ancestors.length) { ?>
25
- <span class="ancestors"><?js= doc.ancestors.join('') ?></span>
26
- <?js } ?>
27
- <?js= doc.name ?>
28
- <?js if (doc.variation) { ?>
29
- <sup class="variation"><?js= doc.variation ?></sup>
30
- <?js } ?></h2>
31
- <?js if (doc.classdesc) { ?>
32
- <div class="class-description"><?js= doc.classdesc ?></div>
33
- <?js } ?>
34
- <?js } else if (doc.kind === 'module' && doc.modules) { ?>
35
- <?js doc.modules.forEach(function(module) { ?>
36
- <?js if (module.classdesc) { ?>
37
- <div class="class-description"><?js= module.classdesc ?></div>
38
- <?js } ?>
39
- <?js }) ?>
40
- <?js } ?>
41
- </header>
42
-
43
- <article>
44
- <div class="container-overview">
45
- <?js if (doc.kind === 'module' && doc.modules) { ?>
46
- <?js if (doc.description) { ?>
47
- <div class="description"><?js= doc.description ?></div>
48
- <?js } ?>
49
-
50
- <?js doc.modules.forEach(function(module) { ?>
51
- <?js= self.partial('method.tmpl', module) ?>
52
- <?js }) ?>
53
- <?js } else if (doc.kind === 'class') { ?>
54
- <?js= self.partial('method.tmpl', doc) ?>
55
- <?js } else { ?>
56
- <?js if (doc.description) { ?>
57
- <div class="description"><?js= doc.description ?></div>
58
- <?js } ?>
59
-
60
- <?js= self.partial('details.tmpl', doc) ?>
61
-
62
- <?js if (doc.examples && doc.examples.length) { ?>
63
- <h3>Example<?js= doc.examples.length > 1? 's':'' ?></h3>
64
- <?js= self.partial('examples.tmpl', doc.examples) ?>
65
- <?js } ?>
66
- <?js } ?>
67
- </div>
68
-
69
- <?js if (doc.augments && doc.augments.length) { ?>
70
- <h3 class="subsection-title">Extends</h3>
71
-
72
- <?js= self.partial('augments.tmpl', doc) ?>
73
- <?js } ?>
74
-
75
- <?js if (doc.requires && doc.requires.length) { ?>
76
- <h3 class="subsection-title">Requires</h3>
77
-
78
- <ul><?js doc.requires.forEach(function(r) { ?>
79
- <li><?js= self.linkto(r, r) ?></li>
80
- <?js }); ?></ul>
81
- <?js } ?>
82
-
83
- <?js
84
- var classes = self.find({kind: 'class', memberof: doc.longname});
85
- if (!isGlobalPage && classes && classes.length) {
86
- ?>
87
- <h3 class="subsection-title">Classes</h3>
88
-
89
- <dl><?js classes.forEach(function(c) { ?>
90
- <dt><?js= self.linkto(c.longname, c.name) ?></dt>
91
- <dd><?js if (c.summary) { ?><?js= c.summary ?><?js } ?></dd>
92
- <?js }); ?></dl>
93
- <?js } ?>
94
-
95
- <?js
96
- var mixins = self.find({kind: 'mixin', memberof: doc.longname});
97
- if (!isGlobalPage && mixins && mixins.length) {
98
- ?>
99
- <h3 class="subsection-title">Mixins</h3>
100
-
101
- <dl><?js mixins.forEach(function(m) { ?>
102
- <dt><?js= self.linkto(m.longname, m.name) ?></dt>
103
- <dd><?js if (m.summary) { ?><?js= m.summary ?><?js } ?></dd>
104
- <?js }); ?></dl>
105
- <?js } ?>
106
-
107
- <?js
108
- var namespaces = self.find({kind: 'namespace', memberof: doc.longname});
109
- if (!isGlobalPage && namespaces && namespaces.length) {
110
- ?>
111
- <h3 class="subsection-title">Namespaces</h3>
112
-
113
- <dl><?js namespaces.forEach(function(n) { ?>
114
- <dt><?js= self.linkto(n.longname, n.name) ?></dt>
115
- <dd><?js if (n.summary) { ?><?js= n.summary ?><?js } ?></dd>
116
- <?js }); ?></dl>
117
- <?js } ?>
118
-
119
- <?js
120
- var members = self.find({kind: 'member', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
121
-
122
- // symbols that are assigned to module.exports are not globals, even though they're not a memberof anything
123
- if (isGlobalPage && members && members.length && members.forEach) {
124
- members = members.filter(function(m) {
125
- return m.longname && m.longname.indexOf('module:') !== 0;
126
- });
127
- }
128
- if (members && members.length && members.forEach) {
129
- ?>
130
- <h3 class="subsection-title">Members</h3>
131
-
132
- <?js members.forEach(function(p) { ?>
133
- <?js= self.partial('members.tmpl', p) ?>
134
- <?js }); ?>
135
- <?js } ?>
136
-
137
- <?js
138
- var methods = self.find({kind: 'function', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
139
- if (methods && methods.length && methods.forEach) {
140
- ?>
141
- <h3 class="subsection-title">Methods</h3>
142
-
143
- <?js methods.forEach(function(m) { ?>
144
- <?js= self.partial('method.tmpl', m) ?>
145
- <?js }); ?>
146
- <?js } ?>
147
-
148
- <?js
149
- var typedefs = self.find({kind: 'typedef', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
150
- if (typedefs && typedefs.length && typedefs.forEach) {
151
- ?>
152
- <h3 class="subsection-title">Type Definitions</h3>
153
-
154
- <?js typedefs.forEach(function(e) {
155
- if (e.signature) {
156
- ?>
157
- <?js= self.partial('method.tmpl', e) ?>
158
- <?js
159
- }
160
- else {
161
- ?>
162
- <?js= self.partial('members.tmpl', e) ?>
163
- <?js
164
- }
165
- }); ?>
166
- <?js } ?>
167
-
168
- <?js
169
- var events = self.find({kind: 'event', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
170
- if (events && events.length && events.forEach) {
171
- ?>
172
- <h3 class="subsection-title">Events</h3>
173
-
174
- <?js events.forEach(function(e) { ?>
175
- <?js= self.partial('method.tmpl', e) ?>
176
- <?js }); ?>
177
- <?js } ?>
178
- </article>
179
-
180
- </section>
181
- <?js } ?>
182
-
183
- <?js }); ?>
@@ -1,143 +0,0 @@
1
- <?js
2
- var data = obj;
3
- var self = this;
4
- var defaultObjectClass = '';
5
-
6
- // Check if the default value is an object or array; if so, apply code highlighting
7
- if (data.defaultvalue && (data.defaultvaluetype === 'object' || data.defaultvaluetype === 'array')) {
8
- data.defaultvalue = "<pre class=\"prettyprint\"><code>" + data.defaultvalue + "</code></pre>";
9
- defaultObjectClass = ' class="object-value"';
10
- }
11
- ?>
12
- <?js
13
- var properties = data.properties;
14
- if (properties && properties.length && properties.forEach) {
15
- ?>
16
-
17
- <h5 class="subsection-title">Properties:</h5>
18
-
19
- <?js= this.partial('properties.tmpl', data) ?>
20
-
21
- <?js } ?>
22
-
23
- <dl class="details">
24
-
25
- <?js if (data.version) {?>
26
- <dt class="tag-version">Version:</dt>
27
- <dd class="tag-version"><ul class="dummy"><li><?js= version ?></li></ul></dd>
28
- <?js } ?>
29
-
30
- <?js if (data.since) {?>
31
- <dt class="tag-since">Since:</dt>
32
- <dd class="tag-since"><ul class="dummy"><li><?js= since ?></li></ul></dd>
33
- <?js } ?>
34
-
35
- <?js if (data.inherited && data.inherits && !data.overrides) { ?>
36
- <dt class="inherited-from">Inherited From:</dt>
37
- <dd class="inherited-from"><ul class="dummy"><li>
38
- <?js= this.linkto(data.inherits, this.htmlsafe(data.inherits)) ?>
39
- </li></ul></dd>
40
- <?js } ?>
41
-
42
- <?js if (data.overrides) { ?>
43
- <dt class="tag-overrides">Overrides:</dt>
44
- <dd class="tag-overrides"><ul class="dummy"><li>
45
- <?js= this.linkto(data.overrides, this.htmlsafe(data.overrides)) ?>
46
- </li></ul></dd>
47
- <?js } ?>
48
-
49
- <?js if (data.implementations && data.implementations.length) { ?>
50
- <dt class="implementations">Implementations:</dt>
51
- <dd class="implementations"><ul>
52
- <?js data.implementations.forEach(function(impl) { ?>
53
- <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
54
- <?js }); ?>
55
- </ul></dd>
56
- <?js } ?>
57
-
58
- <?js if (data.implements && data.implements.length) { ?>
59
- <dt class="implements">Implements:</dt>
60
- <dd class="implements"><ul>
61
- <?js data.implements.forEach(function(impl) { ?>
62
- <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
63
- <?js }); ?>
64
- </ul></dd>
65
- <?js } ?>
66
-
67
- <?js if (data.mixes && data.mixes.length) { ?>
68
- <dt class="mixes">Mixes In:</dt>
69
-
70
- <dd class="mixes"><ul>
71
- <?js data.mixes.forEach(function(a) { ?>
72
- <li><?js= self.linkto(a, a) ?></li>
73
- <?js }); ?>
74
- </ul></dd>
75
- <?js } ?>
76
-
77
- <?js if (data.deprecated) { ?>
78
- <dt class="important tag-deprecated">Deprecated:</dt><?js
79
- if (data.deprecated === true) { ?><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd><?js }
80
- else { ?><dd><ul class="dummy"><li><?js= data.deprecated ?></li></ul></dd><?js }
81
- ?>
82
- <?js } ?>
83
-
84
- <?js if (data.author && author.length) {?>
85
- <dt class="tag-author">Author:</dt>
86
- <dd class="tag-author">
87
- <ul><?js author.forEach(function(a) { ?>
88
- <li><?js= self.resolveAuthorLinks(a) ?></li>
89
- <?js }); ?></ul>
90
- </dd>
91
- <?js } ?>
92
-
93
- <?js if (data.copyright) {?>
94
- <dt class="tag-copyright">Copyright:</dt>
95
- <dd class="tag-copyright"><ul class="dummy"><li><?js= copyright ?></li></ul></dd>
96
- <?js } ?>
97
-
98
- <?js if (data.license) {?>
99
- <dt class="tag-license">License:</dt>
100
- <dd class="tag-license"><ul class="dummy"><li><?js= license ?></li></ul></dd>
101
- <?js } ?>
102
-
103
- <?js if (data.defaultvalue) {?>
104
- <dt class="tag-default">Default Value:</dt>
105
- <dd class="tag-default"><ul class="dummy">
106
- <li<?js= defaultObjectClass ?>><?js= data.defaultvalue ?></li>
107
- </ul></dd>
108
- <?js } ?>
109
-
110
- <?js if (data.meta && self.outputSourceFiles) {?>
111
- <dt class="tag-source">Source:</dt>
112
- <dd class="tag-source"><ul class="dummy"><li>
113
- <?js= self.linkto(meta.shortpath) ?>, <?js= self.linkto(meta.shortpath, 'line ' + meta.lineno, null, 'line' + meta.lineno) ?>
114
- </li></ul></dd>
115
- <?js } ?>
116
-
117
- <?js if (data.tutorials && tutorials.length) {?>
118
- <dt class="tag-tutorial">Tutorials:</dt>
119
- <dd class="tag-tutorial">
120
- <ul><?js tutorials.forEach(function(t) { ?>
121
- <li><?js= self.tutoriallink(t) ?></li>
122
- <?js }); ?></ul>
123
- </dd>
124
- <?js } ?>
125
-
126
- <?js if (data.see && see.length) {?>
127
- <dt class="tag-see">See:</dt>
128
- <dd class="tag-see">
129
- <ul><?js see.forEach(function(s) { ?>
130
- <li><?js= self.linkto(s) ?></li>
131
- <?js }); ?></ul>
132
- </dd>
133
- <?js } ?>
134
-
135
- <?js if (data.todo && todo.length) {?>
136
- <dt class="tag-todo">To Do:</dt>
137
- <dd class="tag-todo">
138
- <ul><?js todo.forEach(function(t) { ?>
139
- <li><?js= t ?></li>
140
- <?js }); ?></ul>
141
- </dd>
142
- <?js } ?>
143
- </dl>
@@ -1,2 +0,0 @@
1
- <?js var data = obj; ?>
2
- <pre><code><?js= data ?></code></pre>
@@ -1,13 +0,0 @@
1
- <?js
2
- var data = obj;
3
- var self = this;
4
-
5
- data.forEach(function(example) {
6
- if (example.caption) {
7
- ?>
8
- <p class="code-caption"><?js= example.caption ?></p>
9
- <?js } ?>
10
- <pre class="prettyprint"><code><?js= self.htmlsafe(example.code) ?></code></pre>
11
- <?js
12
- });
13
- ?>
@@ -1,32 +0,0 @@
1
- <?js
2
- var data = obj;
3
- ?>
4
- <?js if (data.description && data.type && data.type.names) { ?>
5
- <dl>
6
- <dt>
7
- <div class="param-desc">
8
- <?js= data.description ?>
9
- </div>
10
- </dt>
11
- <dd></dd>
12
- <dt>
13
- <dl>
14
- <dt>
15
- Type
16
- </dt>
17
- <dd>
18
- <?js= this.partial('type.tmpl', data.type.names) ?>
19
- </dd>
20
- </dl>
21
- </dt>
22
- <dd></dd>
23
- </dl>
24
- <?js } else { ?>
25
- <div class="param-desc">
26
- <?js if (data.description) { ?>
27
- <?js= data.description ?>
28
- <?js } else if (data.type && data.type.names) { ?>
29
- <?js= this.partial('type.tmpl', data.type.names) ?>
30
- <?js } ?>
31
- </div>
32
- <?js } ?>
@@ -1,47 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width,initial-scale=1">
6
- <title><?js= title ?> - Documentation</title>
7
-
8
- <script src="scripts/prettify/prettify.js"></script>
9
- <script src="scripts/prettify/lang-css.js"></script>
10
- <!--[if lt IE 9]>
11
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
12
- <![endif]-->
13
- <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
14
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
15
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16
- </head>
17
- <body>
18
-
19
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
20
- <label for="nav-trigger" class="navicon-button x">
21
- <div class="navicon"></div>
22
- </label>
23
-
24
- <label for="nav-trigger" class="overlay"></label>
25
-
26
- <nav>
27
- <?js= this.nav ?>
28
- </nav>
29
-
30
- <div id="main">
31
- <?js if (title != 'Home') { ?>
32
- <h1 class="page-title"><?js= title ?></h1>
33
- <?js } ?>
34
-
35
- <?js= content ?>
36
- </div>
37
-
38
- <br class="clear">
39
-
40
- <footer>
41
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc <?js= env.version.number ?></a><?js if(env.conf.templates && env.conf.templates.default && env.conf.templates.default.includeDate !== false) { ?> on <?js= (new Date()) ?><?js } ?> using the Minami theme.
42
- </footer>
43
-
44
- <script>prettyPrint();</script>
45
- <script src="scripts/linenumber.js"></script>
46
- </body>
47
- </html>
@@ -1,10 +0,0 @@
1
- <?js
2
- var data = obj;
3
- var self = this;
4
- ?>
5
-
6
- <?js if (data.readme) { ?>
7
- <section class="readme">
8
- <article><?js= data.readme ?></article>
9
- </section>
10
- <?js } ?>
@@ -1,38 +0,0 @@
1
- <?js
2
- var data = obj;
3
- var self = this;
4
- ?>
5
- <h4 class="name" id="<?js= id ?>"><?js= data.attribs + name + (data.signature ? data.signature : '') ?></h4>
6
-
7
- <?js if (data.summary) { ?>
8
- <p class="summary"><?js= summary ?></p>
9
- <?js } ?>
10
-
11
- <?js if (data.description) { ?>
12
- <div class="description">
13
- <?js= data.description ?>
14
- </div>
15
- <?js } ?>
16
-
17
- <?js if (data.type && data.type.names) {?>
18
- <h5>Type:</h5>
19
- <ul>
20
- <li>
21
- <?js= self.partial('type.tmpl', data.type.names) ?>
22
- </li>
23
- </ul>
24
- <?js } ?>
25
-
26
- <?js= this.partial('details.tmpl', data) ?>
27
-
28
- <?js if (data.fires && fires.length) { ?>
29
- <h5>Fires:</h5>
30
- <ul><?js fires.forEach(function(f) { ?>
31
- <li><?js= self.linkto(f) ?></li>
32
- <?js }); ?></ul>
33
- <?js } ?>
34
-
35
- <?js if (data.examples && examples.length) { ?>
36
- <h5>Example<?js= examples.length > 1? 's':'' ?></h5>
37
- <?js= this.partial('examples.tmpl', examples) ?>
38
- <?js } ?>