nolr

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <title>Documentation Class: Client</title>  <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css"> <link type="text/css" rel="stylesheet" href="styles/site.cerulean.css"> </head> <body> <div class="navbar navbar-default navbar-fixed-top "> <div class="container"> <div class="navbar-header"> <a class="navbar-brand" href="index.html">Documentation</a> <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> </div> <div class="navbar-collapse collapse" id="topNavigation"> <ul class="nav navbar-nav"> <li class="dropdown"> <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a> <ul class="dropdown-menu "> <li><a href="Client.html">Client</a></li><li><a href="Query.html">Query</a></li> </ul> </li> <li class="dropdown"> <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a> <ul class="dropdown-menu "> <li><a href="global.html#_">_</a></li> </ul> </li> </ul> <div class="col-sm-3 col-md-3"> <form class="navbar-form" role="search"> <div class="input-group"> <input type="text" class="form-control" placeholder="Search" name="q" id="search-input"> <div class="input-group-btn"> <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button> </div> </div> </form> </div> </div> </div> </div> <div class="container" id="toc-content"> <div class="row"> <div class="col-md-8"> <div id="main"> <h1 class="page-title">Class: Client</h1> <section> <header> <h2> Client </h2> </header> <article> <div class="container-overview"> <hr> <dt> <h4 class="name" id="Client"><span class="type-signature"></span>new Client(options)</h4> </dt> <dd> <div class="description"> <p>Solr Node Client</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"> <h6 class="method-params-label method-subparams-label">Properties</h6> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>host</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>host address of Solr server</p></td> </tr> <tr> <td class="name"><code>port</code></td> <td class="type"> <span class="param-type">Number</span> | <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>port number of Solr server</p></td> </tr> <tr> <td class="name"><code>core</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>client core name</p></td> </tr> <tr> <td class="name"><code>rootPath</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>solr root path</p></td> </tr> <tr> <td class="name"><code>protocol</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>request protocol ('http'|'https')</p></td> </tr> <tr> <td class="name"><code>debugLevel</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>log4js debug level ('ALL'|'DEBUG'|'INFO'|'ERROR'|...)</p></td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> </dl> </dd> </div> <h3 class="subsection-title">Methods</h3> <dl> <hr> <dt> <h4 class="name" id="_requestGet"><span class="type-signature"></span>_requestGet(path, query, finalCallback)</h4> </dt> <dd> <div class="description"> <p>Request get</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>path</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>target path</p></td> </tr> <tr> <td class="name"><code>query</code></td> <td class="type"> <span class="param-type">Object</span> | <span class="param-type">String</span> </td> <td class="description last"><p>query</p></td> </tr> <tr> <td class="name"><code>finalCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>(err, result)</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <div class="param-desc"> <ul> <li>When there's no callback function it returns a PromiseŰ</li> </ul> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">undefined</span> | <span class="param-type">Promise</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="_requestPost"><span class="type-signature"></span>_requestPost(path, data, urlOptions, finalCallback)</h4> </dt> <dd> <div class="description"> <p>Request post</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>path</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>target path</p></td> </tr> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>json data</p></td> </tr> <tr> <td class="name"><code>urlOptions</code></td> <td class="type"> <span class="param-type">Object</span> | <span class="param-type">String</span> </td> <td class="description last"><p>url options</p></td> </tr> <tr> <td class="name"><code>finalCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>(err, result)</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <div class="param-desc"> <ul> <li>When there's no callback function it returns a PromiseŰ</li> </ul> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">undefined</span> | <span class="param-type">Promise</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="commit"><span class="type-signature"></span>commit(finalCallback)</h4> </dt> <dd> <div class="description"> <p>Commit</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>finalCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>(err, result)</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Undefined</span> | <span class="param-type">Promise</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="delete"><span class="type-signature"></span>delete(query [, options], finalCallback)</h4> </dt> <dd> <div class="description"> <p>Delete</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>query</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Object</span> </td> <td class="attributes"> </td> <td class="description last"><p>query</p></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> | <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>delete options</p></td> </tr> <tr> <td class="name"><code>finalCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> </td> <td class="description last"><p>(err, result)</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Undefined</span> | <span class="param-type">Promise</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="mlt"><span class="type-signature"></span>mlt(query, finalCallback)</h4> </dt> <dd> <div class="description"> <p>Mlt</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>query</code></td> <td class="type"> <span class="param-type">Object</span> | <span class="param-type">String</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>finalCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>(err, result)</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Undefined</span> | <span class="param-type">Promise</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="ping"><span class="type-signature"></span>ping(finalCallback)</h4> </dt> <dd> <div class="description"> <p>Ping</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>finalCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>(err, result)</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Undefined</span> | <span class="param-type">Promise</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="query"><span class="type-signature"></span>query()</h4> </dt> <dd> <div class="description"> <p>Make Query instance and return</p> </div> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Object</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="search"><span class="type-signature"></span>search(query, finalCallback)</h4> </dt> <dd> <div class="description"> <p>Search</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>query</code></td> <td class="type"> <span class="param-type">Object</span> | <span class="param-type">String</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>finalCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>(err, result)</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Undefined</span> | <span class="param-type">Promise</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="softCommit"><span class="type-signature"></span>softCommit(finalCallback)</h4> </dt> <dd> <div class="description"> <p>SoftCommit</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>finalCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>(err, result)</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Undefined</span> | <span class="param-type">Promise</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="spell"><span class="type-signature"></span>spell(query, finalCallback)</h4> </dt> <dd> <div class="description"> <p>Spell</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>query</code></td> <td class="type"> <span class="param-type">Object</span> | <span class="param-type">String</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>finalCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>(err, result)</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Undefined</span> | <span class="param-type">Promise</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="terms"><span class="type-signature"></span>terms(query, finalCallback)</h4> </dt> <dd> <div class="description"> <p>Terms</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>query</code></td> <td class="type"> <span class="param-type">Object</span> | <span class="param-type">String</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>finalCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>(err, result)</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Undefined</span> | <span class="param-type">Promise</span> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="update"><span class="type-signature"></span>update(data [, options], finalCallback)</h4> </dt> <dd> <div class="description"> <p>Update</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> </td> <td class="description last"><p>json data</p></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> | <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>update options</p></td> </tr> <tr> <td class="name"><code>finalCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> </td> <td class="description last"><p>(err, result)</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Undefined</span> | <span class="param-type">Promise</span> </dd> </dl> </dd> </dl> </article> </section> </div> </div> <div class="clearfix"></div> <div class="col-md-3"> <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div> </div> </div> </div> <div class="modal fade" id="searchResults"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button> <h4 class="modal-title">Search results</h4> </div> <div class="modal-body"></div> <div class="modal-footer"> <button type="button" class="btn btn-default" data-dismiss="modal">Close</button> </div> </div> </div> </div> <footer> <span class="jsdoc-message"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on February 23rd 2017, 10:53:04 pm using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. </span> </footer> <script src="scripts/docstrap.lib.js"></script> <script src="scripts/toc.js"></script> <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script> <script> $( function () { $( "[id*='$']" ).each( function () { var $this = $( this ); $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) ); } ); $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () { var $this = $( this ); var example = $this.find( "code" ); exampleText = example.html(); var lang = /{@lang (.*?)}/.exec( exampleText ); if ( lang && lang[1] ) { exampleText = exampleText.replace( lang[0], "" ); example.html( exampleText ); lang = lang[1]; } else { var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/); lang = langClassMatch ? langClassMatch[1] : "javascript"; } if ( lang ) { $this .addClass( "sunlight-highlight-" + lang ) .addClass( "linenums" ) .html( example.html() ); } } ); Sunlight.highlightAll( { lineNumbers : true, showMenu : true, enableDoclinks : true } ); $.catchAnchorLinks( { navbarOffset: 10 } ); $( "#toc" ).toc( { anchorName : function ( i, heading, prefix ) { return $( heading ).attr( "id" ) || ( prefix + i ); }, selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4", showAndHide : false, smoothScrolling: true } ); $( "#main span[id^='toc']" ).addClass( "toc-shim" ); $( '.dropdown-toggle' ).dropdown(); $( "table" ).each( function () { var $this = $( this ); $this.addClass('table'); } ); } ); </script>   <script type="text/javascript"> $(document).ready(function() { SearcherDisplay.init(); }); </script> </body> </html>