File: C:/Ruby27-x64/share/doc/ruby/html/IRB/Notifier.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module IRB::Notifier - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-def_notifier">::def_notifier</a>
<li ><a href="#method-i-def_notifier">#def_notifier</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-IRB::Notifier">
<h1 id="module-IRB::Notifier" class="module">
module IRB::Notifier
</h1>
<section class="description">
<p>An output formatter used internally by the lexer.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-def_notifier" class="method-detail ">
<div class="method-heading">
<span class="method-name">def_notifier</span><span
class="method-args">(prefix = "", output_method = StdioOutputMethod.new)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Define a new <a href="Notifier.html"><code>Notifier</code></a> output source, returning a new <a href="Notifier/CompositeNotifier.html"><code>CompositeNotifier</code></a> with the given <code>prefix</code> and <code>output_method</code>.</p>
<p>The optional <code>prefix</code> will be appended to all objects being inspected during output, using the given <code>output_method</code> as the output source. If no <code>output_method</code> is given, <a href="StdioOutputMethod.html"><code>StdioOutputMethod</code></a> will be used, and all expressions will be sent directly to STDOUT without any additional formatting.</p>
<div class="method-source-code" id="def_notifier-source">
<pre><span class="ruby-comment"># File lib/irb/notifier.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">def_notifier</span>(<span class="ruby-identifier">prefix</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">output_method</span> = <span class="ruby-constant">StdioOutputMethod</span>.<span class="ruby-identifier">new</span>)
<span class="ruby-constant">CompositeNotifier</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">output_method</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-def_notifier" class="method-detail ">
<div class="method-heading">
<span class="method-name">def_notifier</span><span
class="method-args">(prefix = "", output_method = StdioOutputMethod.new)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Define a new <a href="Notifier.html"><code>Notifier</code></a> output source, returning a new <a href="Notifier/CompositeNotifier.html"><code>CompositeNotifier</code></a> with the given <code>prefix</code> and <code>output_method</code>.</p>
<p>The optional <code>prefix</code> will be appended to all objects being inspected during output, using the given <code>output_method</code> as the output source. If no <code>output_method</code> is given, <a href="StdioOutputMethod.html"><code>StdioOutputMethod</code></a> will be used, and all expressions will be sent directly to STDOUT without any additional formatting.</p>
<div class="method-source-code" id="def_notifier-source">
<pre><span class="ruby-comment"># File lib/irb/notifier.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">def_notifier</span>(<span class="ruby-identifier">prefix</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">output_method</span> = <span class="ruby-constant">StdioOutputMethod</span>.<span class="ruby-identifier">new</span>)
<span class="ruby-constant">CompositeNotifier</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">output_method</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>