@loopback/docs

<!DOCTYPE html>     <html class="no-js">  <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> <title></title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <link rel="stylesheet" href="css/bootstrap.min.css"> <link rel="stylesheet" href="css/code-themes/sl-theme.css"> <link rel="stylesheet" href="css/main.css"> </head> <body> <div class="navbar navbar-inverse navbar-static-top" role="navigation"> <div class="navbar-header"> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="/">docs.strongloop.com</a> </div> <div id="modules"></div> </div> <div class="row"> <div class="col-lg-3 column scroll-spy-target"> <ul class="nav nav-pills nav-stacked"> <div id="versions"></div> <li class="depth-1"> <a href="#change-log">Change Log</a> </li> <li class="depth-2"> <a href="#0-7-1-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-7-0-loopback-example-rpc-server-0-7-1-2018-05-08">0.7.1</a> </li> <li class="depth-1"> <a href="#0-7-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-5-3-loopback-example-rpc-server-0-7-0-2018-05-03">0.7.0</a> </li> <li class="depth-3"> <a href="#features">Features</a> </li> <li class="depth-1"> <a href="#0-6-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-5-3-loopback-example-rpc-server-0-6-0-2018-05-03">0.6.0</a> </li> <li class="depth-3"> <a href="#features-1">Features</a> </li> <li class="depth-2"> <a href="#0-5-3-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-5-2-loopback-example-rpc-server-0-5-3-2018-04-26">0.5.3</a> </li> <li class="depth-2"> <a href="#0-5-2-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-5-1-loopback-example-rpc-server-0-5-2-2018-04-26">0.5.2</a> </li> <li class="depth-2"> <a href="#0-5-1-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-5-0-loopback-example-rpc-server-0-5-1-2018-04-25">0.5.1</a> </li> <li class="depth-1"> <a href="#0-5-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-6-loopback-example-rpc-server-0-5-0-2018-04-16">0.5.0</a> </li> <li class="depth-2"> <a href="#0-4-6-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-5-loopback-example-rpc-server-0-4-6-2018-04-12">0.4.6</a> </li> <li class="depth-2"> <a href="#0-4-5-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-4-loopback-example-rpc-server-0-4-5-2018-04-11">0.4.5</a> </li> <li class="depth-2"> <a href="#0-4-4-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-2-loopback-example-rpc-server-0-4-4-2018-04-11">0.4.4</a> </li> <li class="depth-3"> <a href="#bug-fixes">Bug Fixes</a> </li> <li class="depth-2"> <a href="#0-4-3-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-2-loopback-example-rpc-server-0-4-3-2018-04-06">0.4.3</a> </li> <li class="depth-2"> <a href="#0-4-2-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-1-loopback-example-rpc-server-0-4-2-2018-04-04">0.4.2</a> </li> <li class="depth-2"> <a href="#0-4-1-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-0-loopback-example-rpc-server-0-4-1-2018-04-02">0.4.1</a> </li> <li class="depth-1"> <a href="#0-4-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-3-1-loopback-example-rpc-server-0-4-0-2018-03-29">0.4.0</a> </li> <li class="depth-3"> <a href="#code-refactoring">Code Refactoring</a> </li> <li class="depth-3"> <a href="#breaking-changes">BREAKING CHANGES</a> </li> <li class="depth-2"> <a href="#0-3-1-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-3-0-loopback-example-rpc-server-0-3-1-2018-03-23">0.3.1</a> </li> <li class="depth-3"> <a href="#bug-fixes-1">Bug Fixes</a> </li> <li class="depth-1"> <a href="#0-3-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-2-4-loopback-example-rpc-server-0-3-0-2018-03-21">0.3.0</a> </li> <li class="depth-3"> <a href="#bug-fixes-2">Bug Fixes</a> </li> <li class="depth-2"> <a href="#0-2-4-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-2-3-loopback-example-rpc-server-0-2-4-2018-03-14">0.2.4</a> </li> <li class="depth-2"> <a href="#0-2-3-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-2-2-loopback-example-rpc-server-0-2-3-2018-03-13">0.2.3</a> </li> <li class="depth-2"> <a href="#0-2-2-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-2-1-loopback-example-rpc-server-0-2-2-2018-03-08">0.2.2</a> </li> <li class="depth-2"> <a href="#0-2-1-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-2-0-loopback-example-rpc-server-0-2-1-2018-03-06">0.2.1</a> </li> <li class="depth-1"> <a href="#0-2-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-1-2-loopback-example-rpc-server-0-2-0-2018-03-01">0.2.0</a> </li> <li class="depth-2"> <a href="#0-1-2-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-1-1-loopback-example-rpc-server-0-1-2-2018-03-01">0.1.2</a> </li> <li class="depth-3"> <a href="#features-2">Features</a> </li> <li class="depth-3"> <a href="#breaking-changes-1">BREAKING CHANGES</a> </li> <li class="depth-2"> <a href="#0-1-1-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-1-0-loopback-example-rpc-server-0-1-1-2018-02-23">0.1.1</a> </li> <li class="depth-1"> <a href="#0-1-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-4-0-0-alpha-5-loopback-example-rpc-server-0-1-0-2018-02-21">0.1.0</a> </li> <li class="depth-1"> <a href="#4-0-0-alpha-5-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-4-0-0-alpha-4-loopback-example-rpc-server-4-0-0-alpha-5-2018-02-15">4.0.0-alpha.5</a> </li> <li class="depth-1"> <a href="#4-0-0-alpha-4-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-4-0-0-alpha-3-loopback-example-rpc-server-4-0-0-alpha-4-2018-02-07">4.0.0-alpha.4</a> </li> <li class="depth-3"> <a href="#build">build</a> </li> <li class="depth-3"> <a href="#breaking-changes-2">BREAKING CHANGES</a> </li> <li class="depth-1"> <a href="#4-0-0-alpha-3-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-4-0-0-alpha-2-loopback-example-rpc-server-4-0-0-alpha-3-2018-02-04">4.0.0-alpha.3</a> </li> <li class="depth-1"> <a href="#4-0-0-alpha-2-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-4-0-0-alpha-1-loopback-example-rpc-server-4-0-0-alpha-2-2018-01-30">4.0.0-alpha.2</a> </li> <li class="depth-1"> <a href="#4-0-0-alpha-1-2018-01-29">4.0.0-alpha.1</a> </li> <li class="depth-3"> <a href="#bug-fixes-3">Bug Fixes</a> </li> <li class="depth-1"> <a href="#loopback-example-rpc-server">@loopback/example-rpc-server</a> </li> <li class="depth-2"> <a href="#usage">Usage</a> </li> <li class="depth-2"> <a href="#request-format">Request Format</a> </li> <li class="depth-2"> <a href="#contributions">Contributions</a> </li> <li class="depth-2"> <a href="#tests">Tests</a> </li> <li class="depth-2"> <a href="#contributors">Contributors</a> </li> <li class="depth-2"> <a href="#license">License</a> </li> </ul> </div> <div class="col-lg-9 col-lg-offset-3 column" data-spy="scroll" data-target=".scroll-spy-target" data-offset="0"> <div class="readability"> <a name="change-log"></a><h1 id="undefinedchange-log">Change Log <small>v0.7.1</small></h1> <p>All notable changes to this project will be documented in this file. See <a href="https://conventionalcommits.org">Conventional Commits</a> for commit guidelines.</p> <p><a name="0.7.1"></a></p> <a name="0-7-1-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-7-0-loopback-example-rpc-server-0-7-1-2018-05-08"></a><h2 id="undefined0-7-1-2018-05-08-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.7.0...@loopback/example-rpc-server@0.7.1">0.7.1</a> (2018-05-08)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.7.0"></a></p> <a name="0-7-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-5-3-loopback-example-rpc-server-0-7-0-2018-05-03"></a><h1 id="undefined0-7-0-2018-05-03-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.5.3...@loopback/example-rpc-server@0.7.0">0.7.0</a> (2018-05-03)</h1> <a name="features"></a><h3 id="undefinedfeatures">Features</h3> <ul> <li>add helper package "dist-util" (<a href="https://github.com/strongloop/loopback-next/commit/532f153">532f153</a>)</li> </ul> <p><a name="0.6.0"></a></p> <a name="0-6-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-5-3-loopback-example-rpc-server-0-6-0-2018-05-03"></a><h1 id="undefined0-6-0-2018-05-03-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.5.3...@loopback/example-rpc-server@0.6.0">0.6.0</a> (2018-05-03)</h1> <a name="features-1"></a><h3 id="undefinedfeatures">Features</h3> <ul> <li>add helper package "dist-util" (<a href="https://github.com/strongloop/loopback-next/commit/532f153">532f153</a>)</li> </ul> <p><a name="0.5.3"></a></p> <a name="0-5-3-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-5-2-loopback-example-rpc-server-0-5-3-2018-04-26"></a><h2 id="undefined0-5-3-2018-04-26-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.5.2...@loopback/example-rpc-server@0.5.3">0.5.3</a> (2018-04-26)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.5.2"></a></p> <a name="0-5-2-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-5-1-loopback-example-rpc-server-0-5-2-2018-04-26"></a><h2 id="undefined0-5-2-2018-04-26-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.5.1...@loopback/example-rpc-server@0.5.2">0.5.2</a> (2018-04-26)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.5.1"></a></p> <a name="0-5-1-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-5-0-loopback-example-rpc-server-0-5-1-2018-04-25"></a><h2 id="undefined0-5-1-2018-04-25-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.5.0...@loopback/example-rpc-server@0.5.1">0.5.1</a> (2018-04-25)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.5.0"></a></p> <a name="0-5-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-6-loopback-example-rpc-server-0-5-0-2018-04-16"></a><h1 id="undefined0-5-0-2018-04-16-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.4.6...@loopback/example-rpc-server@0.5.0">0.5.0</a> (2018-04-16)</h1> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.4.6"></a></p> <a name="0-4-6-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-5-loopback-example-rpc-server-0-4-6-2018-04-12"></a><h2 id="undefined0-4-6-2018-04-12-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.4.5...@loopback/example-rpc-server@0.4.6">0.4.6</a> (2018-04-12)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.4.5"></a></p> <a name="0-4-5-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-4-loopback-example-rpc-server-0-4-5-2018-04-11"></a><h2 id="undefined0-4-5-2018-04-11-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.4.4...@loopback/example-rpc-server@0.4.5">0.4.5</a> (2018-04-11)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.4.4"></a></p> <a name="0-4-4-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-2-loopback-example-rpc-server-0-4-4-2018-04-11"></a><h2 id="undefined0-4-4-2018-04-11-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.4.2...@loopback/example-rpc-server@0.4.4">0.4.4</a> (2018-04-11)</h2> <a name="bug-fixes"></a><h3 id="undefinedbug-fixes">Bug Fixes</h3> <ul> <li>change file names to fit advocated naming convention (<a href="https://github.com/strongloop/loopback-next/commit/0331df8">0331df8</a>)</li> </ul> <p><a name="0.4.3"></a></p> <a name="0-4-3-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-2-loopback-example-rpc-server-0-4-3-2018-04-06"></a><h2 id="undefined0-4-3-2018-04-06-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.4.2...@loopback/example-rpc-server@0.4.3">0.4.3</a> (2018-04-06)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.4.2"></a></p> <a name="0-4-2-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-1-loopback-example-rpc-server-0-4-2-2018-04-04"></a><h2 id="undefined0-4-2-2018-04-04-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.4.1...@loopback/example-rpc-server@0.4.2">0.4.2</a> (2018-04-04)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.4.1"></a></p> <a name="0-4-1-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-4-0-loopback-example-rpc-server-0-4-1-2018-04-02"></a><h2 id="undefined0-4-1-2018-04-02-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.4.0...@loopback/example-rpc-server@0.4.1">0.4.1</a> (2018-04-02)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.4.0"></a></p> <a name="0-4-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-3-1-loopback-example-rpc-server-0-4-0-2018-03-29"></a><h1 id="undefined0-4-0-2018-03-29-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.3.1...@loopback/example-rpc-server@0.4.0">0.4.0</a> (2018-03-29)</h1> <a name="code-refactoring"></a><h3 id="undefinedcode-refactoring">Code Refactoring</h3> <ul> <li>renamed example-getting-started to example-todo (<a href="https://github.com/strongloop/loopback-next/commit/7a09f1b">7a09f1b</a>)</li> </ul> <a name="breaking-changes"></a><h3 id="undefinedbreaking-changes">BREAKING CHANGES</h3> <ul> <li>example-getting-started is now example-todo</li> </ul> <p><a name="0.3.1"></a></p> <a name="0-3-1-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-3-0-loopback-example-rpc-server-0-3-1-2018-03-23"></a><h2 id="undefined0-3-1-2018-03-23-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.3.0...@loopback/example-rpc-server@0.3.1">0.3.1</a> (2018-03-23)</h2> <a name="bug-fixes-1"></a><h3 id="undefinedbug-fixes">Bug Fixes</h3> <ul> <li><strong>build:</strong> fix select-dist script (<a href="https://github.com/strongloop/loopback-next/commit/e91e810">e91e810</a>)</li> </ul> <p><a name="0.3.0"></a></p> <a name="0-3-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-2-4-loopback-example-rpc-server-0-3-0-2018-03-21"></a><h1 id="undefined0-3-0-2018-03-21-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.2.4...@loopback/example-rpc-server@0.3.0">0.3.0</a> (2018-03-21)</h1> <a name="bug-fixes-2"></a><h3 id="undefinedbug-fixes">Bug Fixes</h3> <ul> <li><strong>example-rpc-server:</strong> include index.ts in tsconfig (<a href="https://github.com/strongloop/loopback-next/commit/a219da3">a219da3</a>)</li> </ul> <p><a name="0.2.4"></a></p> <a name="0-2-4-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-2-3-loopback-example-rpc-server-0-2-4-2018-03-14"></a><h2 id="undefined0-2-4-2018-03-14-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.2.3...@loopback/example-rpc-server@0.2.4">0.2.4</a> (2018-03-14)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.2.3"></a></p> <a name="0-2-3-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-2-2-loopback-example-rpc-server-0-2-3-2018-03-13"></a><h2 id="undefined0-2-3-2018-03-13-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.2.2...@loopback/example-rpc-server@0.2.3">0.2.3</a> (2018-03-13)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.2.2"></a></p> <a name="0-2-2-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-2-1-loopback-example-rpc-server-0-2-2-2018-03-08"></a><h2 id="undefined0-2-2-2018-03-08-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.2.1...@loopback/example-rpc-server@0.2.2">0.2.2</a> (2018-03-08)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.2.1"></a></p> <a name="0-2-1-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-2-0-loopback-example-rpc-server-0-2-1-2018-03-06"></a><h2 id="undefined0-2-1-2018-03-06-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.2.0...@loopback/example-rpc-server@0.2.1">0.2.1</a> (2018-03-06)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.2.0"></a></p> <a name="0-2-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-1-2-loopback-example-rpc-server-0-2-0-2018-03-01"></a><h1 id="undefined0-2-0-2018-03-01-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.1.2...@loopback/example-rpc-server@0.2.0">0.2.0</a> (2018-03-01)</h1> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.1.2"></a></p> <a name="0-1-2-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-1-1-loopback-example-rpc-server-0-1-2-2018-03-01"></a><h2 id="undefined0-1-2-2018-03-01-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.1.1...@loopback/example-rpc-server@0.1.2">0.1.2</a> (2018-03-01)</h2> <a name="features-2"></a><h3 id="undefinedfeatures">Features</h3> <ul> <li><strong>context:</strong> add type as a generic parameter to <code>ctx.get()</code> and friends (<a href="https://github.com/strongloop/loopback-next/commit/24b217d">24b217d</a>)</li> </ul> <a name="breaking-changes-1"></a><h3 id="undefinedbreaking-changes">BREAKING CHANGES</h3> <ul> <li><strong>context:</strong> <code>ctx.get()</code> and <code>ctx.getSync()</code> require a type now. See the example below for upgrade instructions:</li> </ul> <pre><code class="lang-diff"><span class="hljs-deletion">- const c: MyController = await ctx.get('MyController');</span> <span class="hljs-addition">+ const c = await ctx.get<MyController>('MyController');</span> </code></pre> <p><code>isPromise</code> was renamed to <code>isPromiseLike</code> and acts as a type guard for <code>PromiseLike</code>, not <code>Promise</code>. When upgrading affected code, you need to determine whether the code was accepting any Promise implementation (i.e. <code>PromiseLike</code>) or only native Promises. In the former case, you should use <code>isPromiseLike</code> and potentially convert the userland Promise instance to a native Promise via <code>Promise.resolve(promiseLike)</code>. In the latter case, you can replace <code>isPromise(p)</code> with <code>p instanceof Promise</code>.</p> <p><a name="0.1.1"></a></p> <a name="0-1-1-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-0-1-0-loopback-example-rpc-server-0-1-1-2018-02-23"></a><h2 id="undefined0-1-1-2018-02-23-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@0.1.0...@loopback/example-rpc-server@0.1.1">0.1.1</a> (2018-02-23)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="0.1.0"></a></p> <a name="0-1-0-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-4-0-0-alpha-5-loopback-example-rpc-server-0-1-0-2018-02-21"></a><h1 id="undefined0-1-0-2018-02-21-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@4.0.0-alpha.5...@loopback/example-rpc-server@0.1.0">0.1.0</a> (2018-02-21)</h1> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="4.0.0-alpha.5"></a></p> <a name="4-0-0-alpha-5-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-4-0-0-alpha-4-loopback-example-rpc-server-4-0-0-alpha-5-2018-02-15"></a><h1 id="undefined4-0-0-alpha-5-2018-02-15-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@4.0.0-alpha.4...@loopback/example-rpc-server@4.0.0-alpha.5">4.0.0-alpha.5</a> (2018-02-15)</h1> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="4.0.0-alpha.4"></a></p> <a name="4-0-0-alpha-4-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-4-0-0-alpha-3-loopback-example-rpc-server-4-0-0-alpha-4-2018-02-07"></a><h1 id="undefined4-0-0-alpha-4-2018-02-07-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@4.0.0-alpha.3...@loopback/example-rpc-server@4.0.0-alpha.4">4.0.0-alpha.4</a> (2018-02-07)</h1> <a name="build"></a><h3 id="undefinedbuild">build</h3> <ul> <li>drop dist6 related targets (<a href="https://github.com/strongloop/loopback-next/issues/945">#945</a>) (<a href="https://github.com/strongloop/loopback-next/commit/a2368ce">a2368ce</a>)</li> </ul> <a name="breaking-changes-2"></a><h3 id="undefinedbreaking-changes">BREAKING CHANGES</h3> <ul> <li>Support for Node.js version lower than 8.0 has been dropped. Please upgrade to the latest Node.js 8.x LTS version.</li> </ul> <p>Co-Authored-by: Taranveer Virk <a href="mailto:taranveer@virk.cc">taranveer@virk.cc</a></p> <p><a name="4.0.0-alpha.3"></a></p> <a name="4-0-0-alpha-3-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-4-0-0-alpha-2-loopback-example-rpc-server-4-0-0-alpha-3-2018-02-04"></a><h1 id="undefined4-0-0-alpha-3-2018-02-04-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@4.0.0-alpha.2...@loopback/example-rpc-server@4.0.0-alpha.3">4.0.0-alpha.3</a> (2018-02-04)</h1> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="4.0.0-alpha.2"></a></p> <a name="4-0-0-alpha-2-https-github-com-strongloop-loopback-next-compare-loopback-example-rpc-server-4-0-0-alpha-1-loopback-example-rpc-server-4-0-0-alpha-2-2018-01-30"></a><h1 id="undefined4-0-0-alpha-2-2018-01-30-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-rpc-server@4.0.0-alpha.1...@loopback/example-rpc-server@4.0.0-alpha.2">4.0.0-alpha.2</a> (2018-01-30)</h1> <p><strong>Note:</strong> Version bump only for package @loopback/example-rpc-server</p> <p><a name="4.0.0-alpha.1"></a></p> <a name="4-0-0-alpha-1-2018-01-29"></a><h1 id="undefined4-0-0-alpha-1-2018-01-29-">4.0.0-alpha.1 (2018-01-29)</h1> <a name="bug-fixes-3"></a><h3 id="undefinedbug-fixes">Bug Fixes</h3> <ul> <li><strong>example-rpc-server:</strong> mocha opts, mark as private (<a href="https://github.com/strongloop/loopback-next/issues/923">#923</a>) (<a href="https://github.com/strongloop/loopback-next/commit/c3b195d">c3b195d</a>)</li> </ul> <a name="loopback-example-rpc-server"></a><h1 id="undefined-loopback-example-rpc-server">@loopback/example-rpc-server</h1> <p>An example RPC server and application to demonstrate the creation of your own custom server.</p> <p><a href="http://loopback.io/">![powered-by-loopback]</a></p> <a name="usage"></a><h2 id="undefinedusage">Usage</h2> <ol> <li>Install the new loopback CLI toolkit.</li> </ol> <pre><code class="lang-sh">npm i -g @loopback/cli </code></pre> <ol start="2"> <li>Download the "rpc-server" application.</li> </ol> <pre><code class="lang-sh">lb4 example rpc-server </code></pre> <ol start="3"> <li>Switch to the directory and install dependencies.</li> </ol> <pre><code class="lang-sh"><span class="hljs-built_in">cd</span> loopback-example-rpc-server && npm i </code></pre> <ol start="4"> <li>Start the app!</li> </ol> <pre><code class="lang-sh">npm start </code></pre> <p>Next, use your favorite REST client to send RPC payloads to the server (hosted on port 3000).</p> <a name="request-format"></a><h2 id="undefinedrequest-format">Request Format</h2> <p>The request body should contain a controller name, method name and input object. Example:</p> <pre><code class="lang-json">{ <span class="hljs-attr">"controller"</span>: <span class="hljs-string">"GreetController"</span>, <span class="hljs-attr">"method"</span>: <span class="hljs-string">"basicHello"</span>, <span class="hljs-attr">"input"</span>: { <span class="hljs-attr">"name"</span>: <span class="hljs-string">"Janet"</span> } } </code></pre> <p>The router will determine which controller and method will service your request based on the given names in the payload.</p> <a name="contributions"></a><h2 id="undefinedcontributions">Contributions</h2> <ul> <li><a href="https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md">Guidelines</a></li> <li><a href="https://github.com/strongloop/loopback-next/issues/110">Join the team</a></li> </ul> <a name="tests"></a><h2 id="undefinedtests">Tests</h2> <p>Run <code>npm test</code> from the root folder.</p> <a name="contributors"></a><h2 id="undefinedcontributors">Contributors</h2> <p>See <a href="https://github.com/strongloop/loopback-next/graphs/contributors">all contributors</a>.</p> <a name="license"></a><h2 id="undefinedlicense">License</h2> <p>MIT</p> </div> <div class="intentionally-left-blank"></div> </div> </div> <script src="js/vendor/jquery-1.10.1.min.js"></script> <script src="js/vendor/jquery.scrollTo-1.4.3.1.js"></script> <script src="js/vendor/bootstrap.min.js"></script> <script src="js/main.js"></script> </body> </html>