3b092eb529ad0d4622610dafb4fc87bb8424822c.svn-base
12.6 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
<!DOCTYPE html> <html> <head> <title>console.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="../../docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="../..//winston/common.html"> winston/common.html </a> <a class="source" href="../..//winston/config/cli-config.html"> winston/config/cli-config.html </a> <a class="source" href="../..//winston/config/npm-config.html"> winston/config/npm-config.html </a> <a class="source" href="../..//winston/config/syslog-config.html"> winston/config/syslog-config.html </a> <a class="source" href="../..//winston/config.html"> winston/config.html </a> <a class="source" href="../..//winston/exception.html"> winston/exception.html </a> <a class="source" href="../..//winston/logger.html"> winston/logger.html </a> <a class="source" href="../..//winston/transports/console.html"> winston/transports/console.html </a> <a class="source" href="../..//winston/transports/couchdb.html"> winston/transports/couchdb.html </a> <a class="source" href="../..//winston/transports/file.html"> winston/transports/file.html </a> <a class="source" href="../..//winston/transports/loggly.html"> winston/transports/loggly.html </a> <a class="source" href="../..//winston/transports/transport.html"> winston/transports/transport.html </a> <a class="source" href="../..//winston/transports/webhook.html"> winston/transports/webhook.html </a> <a class="source" href="../..//winston/transports.html"> winston/transports.html </a> <a class="source" href="../..//winston.html"> winston.html </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> console.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> </td> <td class="code"> <div class="highlight"><pre><span class="cm">/*</span>
<span class="cm"> * console.js: Transport for outputting to the console</span>
<span class="cm"> *</span>
<span class="cm"> * (C) 2010 Charlie Robbins</span>
<span class="cm"> * MIT LICENCE</span>
<span class="cm"> *</span>
<span class="cm"> */</span>
<span class="kd">var</span> <span class="nx">events</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'events'</span><span class="p">),</span>
<span class="nx">util</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'util'</span><span class="p">),</span>
<span class="nx">colors</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'colors'</span><span class="p">),</span>
<span class="nx">common</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'../common'</span><span class="p">),</span>
<span class="nx">Transport</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'./transport'</span><span class="p">).</span><span class="nx">Transport</span><span class="p">;</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h3>function Console (options)</h3>
<h4>@options {Object} Options for this instance.</h4>
<p>Constructor function for the Console transport object responsible
for persisting log messages and metadata to a terminal or TTY.</p> </td> <td class="code"> <div class="highlight"><pre><span class="kd">var</span> <span class="nx">Console</span> <span class="o">=</span> <span class="nx">exports</span><span class="p">.</span><span class="nx">Console</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">options</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">Transport</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="k">this</span><span class="p">,</span> <span class="nx">options</span><span class="p">);</span>
<span class="nx">options</span> <span class="o">=</span> <span class="nx">options</span> <span class="o">||</span> <span class="p">{};</span>
<span class="k">this</span><span class="p">.</span><span class="nx">name</span> <span class="o">=</span> <span class="s1">'console'</span><span class="p">;</span>
<span class="k">this</span><span class="p">.</span><span class="nx">json</span> <span class="o">=</span> <span class="nx">options</span><span class="p">.</span><span class="nx">json</span> <span class="o">||</span> <span class="kc">false</span><span class="p">;</span>
<span class="k">this</span><span class="p">.</span><span class="nx">colorize</span> <span class="o">=</span> <span class="nx">options</span><span class="p">.</span><span class="nx">colorize</span> <span class="o">||</span> <span class="kc">false</span><span class="p">;</span>
<span class="k">this</span><span class="p">.</span><span class="nx">timestamp</span> <span class="o">=</span> <span class="k">typeof</span> <span class="nx">options</span><span class="p">.</span><span class="nx">timestamp</span> <span class="o">!==</span> <span class="s1">'undefined'</span> <span class="o">?</span> <span class="nx">options</span><span class="p">.</span><span class="nx">timestamp</span> <span class="o">:</span> <span class="kc">false</span><span class="p">;</span>
<span class="p">};</span></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <p>Inherit from <code>winston.Transport</code>.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">util</span><span class="p">.</span><span class="nx">inherits</span><span class="p">(</span><span class="nx">Console</span><span class="p">,</span> <span class="nx">Transport</span><span class="p">);</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <p>Expose the name of this Transport on the prototype</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">Console</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">name</span> <span class="o">=</span> <span class="s1">'console'</span><span class="p">;</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <h3>function log (level, msg, [meta], callback)</h3>
<h4>@level {string} Level at which to log the message.</h4>
<h4>@msg {string} Message to log</h4>
<h4>@meta {Object} <strong>Optional</strong> Additional metadata to attach</h4>
<h4>@callback {function} Continuation to respond to when complete.</h4>
<p>Core logging method exposed to Winston. Metadata is optional.</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">Console</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">log</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">level</span><span class="p">,</span> <span class="nx">msg</span><span class="p">,</span> <span class="nx">meta</span><span class="p">,</span> <span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">silent</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">callback</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="kc">true</span><span class="p">);</span>
<span class="p">}</span>
<span class="kd">var</span> <span class="nx">self</span> <span class="o">=</span> <span class="k">this</span><span class="p">,</span> <span class="nx">output</span> <span class="o">=</span> <span class="nx">common</span><span class="p">.</span><span class="nx">log</span><span class="p">({</span>
<span class="nx">level</span><span class="o">:</span> <span class="nx">level</span><span class="p">,</span>
<span class="nx">message</span><span class="o">:</span> <span class="nx">msg</span><span class="p">,</span>
<span class="nx">meta</span><span class="o">:</span> <span class="nx">meta</span><span class="p">,</span>
<span class="nx">colorize</span><span class="o">:</span> <span class="k">this</span><span class="p">.</span><span class="nx">colorize</span><span class="p">,</span>
<span class="nx">timestamp</span><span class="o">:</span> <span class="k">this</span><span class="p">.</span><span class="nx">timestamp</span>
<span class="p">});</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">level</span> <span class="o">===</span> <span class="s1">'error'</span> <span class="o">||</span> <span class="nx">level</span> <span class="o">===</span> <span class="s1">'debug'</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">util</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="nx">output</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">else</span> <span class="p">{</span>
<span class="nx">util</span><span class="p">.</span><span class="nx">puts</span><span class="p">(</span><span class="nx">output</span><span class="p">);</span>
<span class="p">}</span></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <p>Emit the <code>logged</code> event immediately because the event loop
will not exit until <code>process.stdout</code> has drained anyway.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">self</span><span class="p">.</span><span class="nx">emit</span><span class="p">(</span><span class="s1">'logged'</span><span class="p">);</span>
<span class="nx">callback</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="kc">true</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>