453 lines
8.3 KiB
HTML
453 lines
8.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>
|
|
»
|
|
<a href='../alphabetical_index.html' title='Index'>
|
|
Index
|
|
</a>
|
|
»
|
|
<span class='title'>Environment</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
Environment
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>node_modules/grunt-codo/node_modules/codo/lib/environment.coffee</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Class Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#read-static'>
|
|
.
|
|
(void)
|
|
<b>read</b><span>(files, options = {})</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#readCoffee-dynamic'>
|
|
#
|
|
(void)
|
|
<b>readCoffee</b><span>(file)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#readExtra-dynamic'>
|
|
#
|
|
(void)
|
|
<b>readExtra</b><span>(file)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#registerEntity-dynamic'>
|
|
#
|
|
(void)
|
|
<b>registerEntity</b><span>(entity)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#all-dynamic'>
|
|
#
|
|
(void)
|
|
<b>all</b><span>(Entity, haystack = [])</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#allFiles-dynamic'>
|
|
#
|
|
(void)
|
|
<b>allFiles</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#allClasses-dynamic'>
|
|
#
|
|
(void)
|
|
<b>allClasses</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#allMixins-dynamic'>
|
|
#
|
|
(void)
|
|
<b>allMixins</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#allExtras-dynamic'>
|
|
#
|
|
(void)
|
|
<b>allExtras</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#allMethods-dynamic'>
|
|
#
|
|
(void)
|
|
<b>allMethods</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#allVariables-dynamic'>
|
|
#
|
|
(void)
|
|
<b>allVariables</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#find-dynamic'>
|
|
#
|
|
(void)
|
|
<b>find</b><span>(Entity, name)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#findReadme-dynamic'>
|
|
#
|
|
(void)
|
|
<b>findReadme</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#linkify-dynamic'>
|
|
#
|
|
(void)
|
|
<b>linkify</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#reference-dynamic'>
|
|
#
|
|
(void)
|
|
<b>reference</b><span>(needle, context = '')</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#inspect-dynamic'>
|
|
#
|
|
(void)
|
|
<b>inspect</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>Class Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='read-static'>
|
|
.
|
|
(void)
|
|
<b>read</b><span>(files, options = {})</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2>Constructor Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='constructor-dynamic'>
|
|
#
|
|
(void)
|
|
<b>constructor</b><span>(options = {})</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2>Instance Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='readCoffee-dynamic'>
|
|
#
|
|
(void)
|
|
<b>readCoffee</b><span>(file)</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='readExtra-dynamic'>
|
|
#
|
|
(void)
|
|
<b>readExtra</b><span>(file)</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='registerEntity-dynamic'>
|
|
#
|
|
(void)
|
|
<b>registerEntity</b><span>(entity)</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='all-dynamic'>
|
|
#
|
|
(void)
|
|
<b>all</b><span>(Entity, haystack = [])</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='allFiles-dynamic'>
|
|
#
|
|
(void)
|
|
<b>allFiles</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='allClasses-dynamic'>
|
|
#
|
|
(void)
|
|
<b>allClasses</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='allMixins-dynamic'>
|
|
#
|
|
(void)
|
|
<b>allMixins</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='allExtras-dynamic'>
|
|
#
|
|
(void)
|
|
<b>allExtras</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='allMethods-dynamic'>
|
|
#
|
|
(void)
|
|
<b>allMethods</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='allVariables-dynamic'>
|
|
#
|
|
(void)
|
|
<b>allVariables</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='find-dynamic'>
|
|
#
|
|
(void)
|
|
<b>find</b><span>(Entity, name)</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='findReadme-dynamic'>
|
|
#
|
|
(void)
|
|
<b>findReadme</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='linkify-dynamic'>
|
|
#
|
|
(void)
|
|
<b>linkify</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='reference-dynamic'>
|
|
#
|
|
(void)
|
|
<b>reference</b><span>(needle, context = '')</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='inspect-dynamic'>
|
|
#
|
|
(void)
|
|
<b>inspect</b><span>()</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
|
|
✲
|
|
Press H to see the keyboard shortcuts
|
|
✲
|
|
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
|
|
✲
|
|
<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> |