yjs/doc/class/MissingFatArrows.html
2014-08-12 19:18:56 +02:00

343 lines
7.3 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>CoffeeScript API Documentation</title>
<script src='../javascript/application.js'></script>
<script src='../javascript/search.js'></script>
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../extra/README.md.html' title='Yatta'>
Yatta
</a>
&raquo;
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>MissingFatArrows</span>
</div>
</div>
<div id='content'>
<h1>
Class:
MissingFatArrows
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>node_modules&#47;gulp-coffeelint&#47;node_modules&#47;coffeelint&#47;src&#47;rules&#47;missing_fat_arrows.coffee</td>
</tr>
</table>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='rule-variable'>
rule
=
</dt>
<dd>
<pre><code class='coffeescript'>{
name: &#39;missing_fat_arrows&#39;,
level: &#39;ignore&#39;,
message: &#39;Used `this` in a function without a fat arrow&#39;,
description: &quot;Warns when you use `this` inside a function that wasn&#39;t defined\nwith a fat arrow. This rule does not apply to methods defined in a\nclass, since they have `this` bound to the class instance (or the\nclass itself, for class methods).\n\nIt is impossible to statically determine whether a function using\n`this` will be bound with the correct `this` value due to language\nfeatures like `Function.prototype.call` and\n`Function.prototype.bind`, so this rule may produce false positives.&quot;
}</code></pre>
</dd>
</dl>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#lintAST-dynamic'>
#
(void)
<b>lintAST</b><span>(node, astApi)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#lintNode-dynamic'>
#
(void)
<b>lintNode</b><span>(node, methods = [])</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isCode-dynamic'>
#
(void)
<b>isCode</b><span>(node)</span>
</a>
</span>
<span class='bound note title'>Bound</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isClass-dynamic'>
#
(void)
<b>isClass</b><span>(node)</span>
</a>
</span>
<span class='bound note title'>Bound</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isValue-dynamic'>
#
(void)
<b>isValue</b><span>(node)</span>
</a>
</span>
<span class='bound note title'>Bound</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isObject-dynamic'>
#
(void)
<b>isObject</b><span>(node)</span>
</a>
</span>
<span class='bound note title'>Bound</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isThis-dynamic'>
#
(void)
<b>isThis</b><span>(node)</span>
</a>
</span>
<span class='bound note title'>Bound</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isFatArrowCode-dynamic'>
#
(void)
<b>isFatArrowCode</b><span>(node)</span>
</a>
</span>
<span class='bound note title'>Bound</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#needsFatArrow-dynamic'>
#
(void)
<b>needsFatArrow</b><span>(node)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#methodsOfClass-dynamic'>
#
(void)
<b>methodsOfClass</b><span>(classNode)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='lintAST-dynamic'>
#
(void)
<b>lintAST</b><span>(node, astApi)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='lintNode-dynamic'>
#
(void)
<b>lintNode</b><span>(node, methods = [])</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isCode-dynamic'>
#
(void)
<b>isCode</b><span>(node)</span>
<span class='bound note'>Bound</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isClass-dynamic'>
#
(void)
<b>isClass</b><span>(node)</span>
<span class='bound note'>Bound</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isValue-dynamic'>
#
(void)
<b>isValue</b><span>(node)</span>
<span class='bound note'>Bound</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isObject-dynamic'>
#
(void)
<b>isObject</b><span>(node)</span>
<span class='bound note'>Bound</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isThis-dynamic'>
#
(void)
<b>isThis</b><span>(node)</span>
<span class='bound note'>Bound</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isFatArrowCode-dynamic'>
#
(void)
<b>isFatArrowCode</b><span>(node)</span>
<span class='bound note'>Bound</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='needsFatArrow-dynamic'>
#
(void)
<b>needsFatArrow</b><span>(node)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='methodsOfClass-dynamic'>
#
(void)
<b>methodsOfClass</b><span>(classNode)</span>
<br>
</p>
</div>
</div>
</div>
<div id='footer'>
August 12, 14 06:33:02 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.0.9
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>