documon
Version:
A documentation system for mortals. Use with any language.
250 lines (135 loc) • 7.29 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>log</title>
<meta name="description" content="Writes to the console. Will accept an object or array as well as string, boolena and other and prepare them for proper presentation to the console.">
<!-- Normalize -->
<link rel="stylesheet" href="assets/vendor/normalize.css">
<!-- prettify -->
<link rel="stylesheet" href="assets/vendor/prettify/codamike.css">
<script src="assets/vendor/prettify/prettify.js"></script>
<!-- Documon Pages Info. (Used by various classes to identify this page.) -->
<script>
var pageCtx = {
id : "documon.log",
name: "log"
}
</script>
<!-- theme
<link rel="stylesheet" href="assets/fonts/Fira_Sans/FiraSans.css">
<link rel="stylesheet" href="assets/fonts/Inconsolata/inconsolata.css">
-->
<link rel="stylesheet" href="assets/css/pages.css">
<script src="assets/js/documon/Storage.js"></script>
<script src="assets/js/documon/Access.js"></script>
<script src="assets/js/documon/Pages.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-106684927-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div class="page">
<div class="main-method">
<a name="methods"></a>
<div class="part-methods">
<a name="documon.log"></a><a name="log"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
log (<span class="method-arguments">data</span>, <span class="method-arguments">title</span>, <span class="method-arguments">quiet</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/src/log.js</span>
<span class="member-line-number">32</span>
</span>
</div>
<div class="member-description">
<div class="meta-block meta-block-klass">
<div class="meta-line"><span class="meta-label" >xpath</span> <span class="meta-target">documon.log<span></div>
<div class="meta-line"><span class="meta-label" >file</span> <span class="meta-target">documon/src/log.js<span></div>
</div>
<p>Writes to the console. Will accept an object or array as well as string, boolena and other and prepare them for proper presentation to the console.</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">data</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">any</span>
<div class="member-description">
<p>A string, array or object to output</p>
</div>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">title</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>A title for the message</p>
</div>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">quiet</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">type</span>
<div class="member-description">
<p>Disables logging (prevents console output.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<div class="heading-example">Example</div>
<div class="example-block">
<pre><code>var log = require("log");
log(["foo", "bar"], "Some Title", false);</code></pre>
<p>prints:</p>
<pre><code> --------------------
Some Title
--------------------
[
'foo',
'bar'
]</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="parts">
</div>
</div>
<div class="footer">Generated by <a href="http://www.documon.net" target="_blank">Documon</a></div>
</body>
</html>