libs/js/jquery-mobile-1.2.0/node_modules/grunt/node_modules/prompt/node_modules/winston/docs/winston/transports/console.html

   1 <!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 &hellip;         <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">&#182;</a>               </div>                            </td>             <td class="code">               <div class="highlight"><pre><span class="cm">/*</span>
   2 <span class="cm"> * console.js: Transport for outputting to the console</span>
   3 <span class="cm"> *</span>
   4 <span class="cm"> * (C) 2010 Charlie Robbins</span>
   5 <span class="cm"> * MIT LICENCE</span>
   6 <span class="cm"> *</span>
   7 <span class="cm"> */</span>
   8
   9 <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">&#39;events&#39;</span><span class="p">),</span>
  10     <span class="nx">util</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;util&#39;</span><span class="p">),</span>
  11     <span class="nx">colors</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;colors&#39;</span><span class="p">),</span>
  12     <span class="nx">common</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;../common&#39;</span><span class="p">),</span>
  13     <span class="nx">Transport</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;./transport&#39;</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">&#182;</a>               </div>               <h3>function Console (options)</h3>
  14
  15 <h4>@options {Object} Options for this instance.</h4>
  16
  17 <p>Constructor function for the Console transport object responsible
  18 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>
  19   <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>
  20   <span class="nx">options</span> <span class="o">=</span> <span class="nx">options</span> <span class="o">||</span> <span class="p">{};</span>
  21
  22   <span class="k">this</span><span class="p">.</span><span class="nx">name</span>      <span class="o">=</span> <span class="s1">&#39;console&#39;</span><span class="p">;</span>
  23   <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>
  24   <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>
  25   <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">&#39;undefined&#39;</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>
  26 <span class="p">};</span></pre></div>             </td>           </tr>                               <tr id="section-3">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-3">&#182;</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">&#182;</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">&#39;console&#39;</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">&#182;</a>               </div>               <h3>function log (level, msg, [meta], callback)</h3>
  27
  28 <h4>@level {string} Level at which to log the message.</h4>
  29
  30 <h4>@msg {string} Message to log</h4>
  31
  32 <h4>@meta {Object} <strong>Optional</strong> Additional metadata to attach</h4>
  33
  34 <h4>@callback {function} Continuation to respond to when complete.</h4>
  35
  36 <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>
  37   <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>
  38     <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>
  39   <span class="p">}</span>
  40
  41   <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>
  42     <span class="nx">level</span><span class="o">:</span>     <span class="nx">level</span><span class="p">,</span>
  43     <span class="nx">message</span><span class="o">:</span>   <span class="nx">msg</span><span class="p">,</span>
  44     <span class="nx">meta</span><span class="o">:</span>      <span class="nx">meta</span><span class="p">,</span>
  45     <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>
  46     <span class="nx">timestamp</span><span class="o">:</span> <span class="k">this</span><span class="p">.</span><span class="nx">timestamp</span>
  47   <span class="p">});</span>
  48
  49   <span class="k">if</span> <span class="p">(</span><span class="nx">level</span> <span class="o">===</span> <span class="s1">&#39;error&#39;</span> <span class="o">||</span> <span class="nx">level</span> <span class="o">===</span> <span class="s1">&#39;debug&#39;</span><span class="p">)</span> <span class="p">{</span>
  50     <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>
  51   <span class="p">}</span>
  52   <span class="k">else</span> <span class="p">{</span>
  53     <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>
  54   <span class="p">}</span></pre></div>             </td>           </tr>                               <tr id="section-6">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-6">&#182;</a>               </div>               <p>Emit the <code>logged</code> event immediately because the event loop
  55 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">&#39;logged&#39;</span><span class="p">);</span>
  56   <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>
  57 <span class="p">};</span>
  58
  59 </pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html>