can

<!DOCTYPE html>  <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - requestHandler</title> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"> <link rel="stylesheet" type="text/css" href="./static/bundles/bit-docs-site/static.css"> <link rel="shortcut icon" sizes="16x16 24x24 32x32 48x48 64x64" href="/docs/images/canjs_favicon.ico"> <link rel="apple-touch-icon" sizes="57x57" href="../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon-precomposed" sizes="57x57" href="../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon" sizes="72x72" href="../docs/images/canjs_favicon_72x72.png"> <link rel="apple-touch-icon" sizes="114x114" href="../docs/images/canjs_favicon_114x114.png"> <link rel="apple-touch-icon" sizes="120x120" href="../docs/images/canjs_favicon_128x128.png"> <link rel="apple-touch-icon" sizes="144x144" href="../docs/images/canjs_favicon_144x144.png"> <link rel="apple-touch-icon" sizes="152x152" href="../docs/images/canjs_favicon_152x152.png"> <meta content="yes" name="apple-mobile-web-app-capable"> <meta name="apple-mobile-web-app-status-bar-style" content="white-translucent"> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-2302003-11', 'auto'); ga('send', 'pageview'); </script> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger"/> <label for="nav-trigger">Menu</label> <div id="everything"> <div id="left" class="column"> <div class="top-left"> <div class="brand"> <div class="logo"> <a href="../index.html" alt="CanJS"></a> <div class="dropdown project-dropdown"> <a href="https://donejs.com/">DoneJS</a> <a href="http://stealjs.com/">StealJS</a> <a href="http://jquerypp.com/">jQuery ++</a> <a href="https://funcunit.com/">FuncUnit</a> <a href="http://documentjs.com/">DocumentJS</a> </div> </div> <div class="version"> <div class="version-number"> 3.0.0 </div> <div class="dropdown version-dropdown"> <a href="https://v2.canjs.com">2.3.27</a> </div> </div> </div> <div class="search-bar"> <p>   </p> </div> </div> <div class="bottom-left"> <div class="social-side-container"> <ul class="social-side"> <li> <a class="header-mobile github" href="https://github.com/canjs/canjs" target="_blank"><img class="social-icon-small" src="../docs/images/github.png">Github</a> </li> <li> <a class="header-mobile twitter" href="https://twitter.com/canjs" target="_blank"><img class="social-icon-small" src="../docs/images/twitter.png">Twitter</a> </li> </ul> <ul class="social-side"> <li> <a class="header-mobile" href="https://gitter.im/canjs/canjs" target="_blank">Chat</a> </li> <li> <a class="header-mobile" href="http://forums.donejs.com/c/canjs" target="_blank">Forum</a> </li> </ul> </div> <ul> <li class=" "> <a class="page" href="guides.html" title="Welcome to CanJS! These guides are here to help you develop and improve your relationship with CanJS. After all, picking a JavaScript framework is a commitment. We want CanJS to be the framework you marry. This page helps you know how advance through the different stages of this relationship:"> Guides </a> </li> <li class=" "> <a class="page" href="can-core.html" title="The best, most hardened and generally useful libraries in CanJS."> Core </a> </li> <li class=" parent expanded"> <a class="page" href="can-ecosystem.html" title="Useful libraries that extend or add important features to the core collection."> Ecosystem </a> <ul> <li class=" "> <a class="module" href="can-construct-super.html" title="can.Construct.super is a plugin that makes it easier to call base functions from inside inheriting functions."> can-construct-super </a> </li> <li class=" "> <a class="module" href="can-define-stream.html" title="Define property values using streams. can-stream is used internally to provide the stream functionality."> can-define-stream </a> </li> <li class=" parent expanded"> <a class="module" href="can-fixture.html" title="can-fixture intercepts an AJAX request and simulates the response with a file or function."> can-fixture </a> <ul> <li> <span>types</span> <ul> <li class=" "> <a class="function" href="can-fixture/StoreType.html" title=""> Store </a> </li> <li class=" "> <a class="typedef" href="can-fixture/types/ajaxSettings.html" title="An object used to match incoming request objects."> ajaxSettings </a> </li> <li class=" "> <a class="typedef" href="can-fixture/types/request.html" title="An object with easily digestible values derived from the mock XHR object."> request </a> </li> <li class="current parent expanded"> <a class="typedef" href="can-fixture.requestHandler.html" title=""> requestHandler </a> </li> <li class=" "> <a class="typedef" href="can-fixture.response.html" title=""> response </a> </li> </ul> </li> <li> <span>properties</span> <ul> <li class=" "> <a class="property" href="can-fixture.delay.html" title="can-fixture.delay"> delay </a> </li> <li class=" "> <a class="property" href="can-fixture.on.html" title=""> on </a> </li> <li class=" "> <a class="function" href="can-fixture.rand.html" title=""> rand </a> </li> <li class=" "> <a class="function" href="can-fixture.store.html" title=""> store </a> </li> </ul> </li> </ul> </li> <li class=" "> <a class="module" href="can-fixture-socket.html" title="Simulate socket.io services."> can-fixture-socket </a> </li> <li class=" "> <a class="module" href="can-jquery.html" title="Extensions to the event system so that can events and jQuery events are cross-bound. Importing can-jquery will return the jQuery object and wire up the event system. var $ = require("can-jquery"); var div = $("<div>"); div.on("inserted", function(){ // it inserted! }); $("body").append(div);"> can-jquery </a> </li> <li class=" "> <a class="module" href="can-stache-converters.html" title="Provides a set of converters useful for two-way binding with form elements such as <input> and <select>."> can-stache-converters </a> </li> <li class=" "> <a class="module" href="can-stream.html" title="Convert observable values into streams. Kefir is used internally to provide the stream functionality."> can-stream </a> </li> <li class=" "> <a class="module" href="can-vdom.html" title="A browser-lite environment for Node.js or a worker thread."> can-vdom </a> </li> <li class=" "> <a class="module" href="can-view-import.html" title=""> can-view-import </a> </li> <li class=" "> <a class="module" href="can-zone.html" title=""> can-zone </a> </li> <li class=" "> <a class="module" href="steal-stache.html" title="A StealJS extension that allows stache templates as dependencies."> steal-stache </a> </li> </ul> </li> <li class=" "> <a class="page" href="can-infrastructure.html" title="Utility libraries that power the core and ecosystem collection."> Infrastructure </a> </li> <li class=" "> <a class="page" href="can-legacy.html" title="Former libraries that we still accept patches for, but are not under active development."> Legacy </a> </li> </ul> </div> </div> <div id="right" class="column"> <div class="top-right"> <div class="top-right-top"> <ul class="top-right-bitovi"> <li class="dropdown"> <a href="http://bitovi.com" class="bitovi icon-bits">Bitovi</a> <ul class="dropdown-menu"> <li><a href="http://bitovi.com">Bitovi.com</a></li> <li><a href="http://bitovi.com/blog/">Blog</a></li> <li><a href="http://bitovi.com/consulting/">Consulting</a></li> <li><a href="http://bitovi.com/training/">Training</a></li> <li><a href="http://bitovi.com/open-source/">Open Source</a></li> </ul> </li> </ul> <div class="brand"> <div class="logo"> <a href="../index.html" alt="CanJS"></a> </div> </div> <ul class="top-right-links"> <li> <a href="https://gitter.im/canjs/canjs">Chat</a> </li> <li> <a href="http://forums.donejs.com/c/canjs">Forum</a> </li> <li> <a class="github-button nav-social" href="https://github.com/canjs/canjs" data-count-href="/canjs/canjs/stargazers" data-count-api="/repos/canjs/canjs#stargazers_count">Star</a> </li> <li> <a href="https://twitter.com/canjs" class="twitter-follow-button nav-social" data-show-count="true" data-show-screen-name="false">Follow @canjs</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </li> </ul> </div> <div class="breadcrumb"> <li><a href="../index.html">CanJS</a></li> / <li><a href="can-ecosystem.html">Ecosystem</a></li> / <li><a href="can-fixture.html">can-fixture</a></li> / <li><a href="can-fixture.requestHandler.html">requestHandler</a></li> <li class="breadcrumb-dropdown">/ <a> On this page</a> <ul class="on-this-page"></ul> </li> <div class="nav-toggle" title="Back to top"></div> </div> </div> <div class="bottom-right"> <article> <section class="title"> <div class="page-type"> <h1>requestHandler</h1> <div>typedef</div> </div> <section class="description"> </section> </section> <section class="on-this-page-table"> </section> <section class="title-footer"> <ul class="title-links">  <li><a href="//github.com/canjs/can-fixture/tree/v1.0.7/docs/types/requestHandler.md">source</a></li>   </ul> </section> <div class="signature"> <h2 class="signature-title"> <code>requestHandler(request, response(...), requestHeaders, ajaxSettings)</code> </h2> <p>Defines the XHR response for a given trapped request.</p> <pre><code class="language-js">fixture({method: "get", url: "/todos"}, function(request, response, headers, ajaxSettings){ request //-> { // method: "get", // url: "/todos", // data: {complete: true} // } } }); $.ajax({ method: "get", url: "/todos?complete=true" }) </code></pre> <p>Templated <code>url</code> data will be added to the <code>requestHandler</code>'s <code>request</code> argument's <code>data</code> property:</p> <pre><code class="language-js">fixture({url: "/todos/{action}"}, function(request, response, headers, ajaxSettings){ request //-> { // method: "post", // url: "/todos", // data: {action: delete} // } } }); $.post("/todos/delete"); </code></pre> <div class="parameters"> <h3 class="parameters-title">Parameters</h3> <ol> <li><b>request</b> <code>{<a href="can-fixture/types/request.html" title="An object with easily digestible values derived from the mock XHR object.">request</a>}</code>: <p>Information about the request. The request's data property will contain data from the request's querystring or request body. Also any templated values in the <a href="can-fixture/types/ajaxSettings.html" title="An object used to match incoming request objects.">ajaxSettings</a>'s <code>url</code> will be added.</p> </li> <li><b>response</b> <code>{<a href="can-fixture.response.html" title="">response</a>()}</code>: <p>A callback function that provides response information.</p> </li> <li><b>requestHeaders</b> <code>{Object}</code>: <p>Headers used to make the request.</p> </li> <li><b>ajaxSettings</b> <code>{Object}</code>: <p>The settings object used to match this request.</p> </li> </ol> </div> </div> <script type="text/javascript"> var docObject = {"src":{"path":"node_modules/can-fixture/docs/types/requestHandler.md"},"description":"\n","type":"typedef","title":"requestHandler","types":[{"type":"function","returns":{"types":[{"type":"undefined"}]},"params":[{"types":[{"type":"can-fixture/types/request"}],"name":"request"},{"types":[{"type":"can-fixture.response"}],"name":"response"},{"types":[{"type":"Object","options":[]}],"name":"requestHeaders"},{"types":[{"type":"Object","options":[]}],"name":"ajaxSettings"}]}],"name":"can-fixture.requestHandler","parent":"can-fixture.types","signatures":[{"code":"requestHandler(request, response(...), requestHeaders, ajaxSettings)","description":"\n\nDefines the XHR response for a given trapped request.\n\n```js\nfixture({method: \"get\", url: \"/todos\"},\n function(request, response, headers, ajaxSettings){\n request //-> {\n // method: \"get\",\n // url: \"/todos\",\n // data: {complete: true}\n // }\n\n }\n});\n\n$.ajax({ method: \"get\", url: \"/todos?complete=true\" })\n```\n\nTemplated `url` data will be added to the `requestHandler`'s `request` argument's `data` property:\n\n```js\nfixture({url: \"/todos/{action}\"},\n function(request, response, headers, ajaxSettings){\n request //-> {\n // method: \"post\",\n // url: \"/todos\",\n // data: {action: delete}\n // }\n }\n});\n\n$.post(\"/todos/delete\");\n```","params":[{"types":[{"type":"can-fixture/types/request"}],"name":"request","description":"Information about the request. The request's data property will contain data from the request's querystring or request body. Also\nany templated values in the [can-fixture/types/ajaxSettings]'s `url` will be added. "},{"types":[{"type":"can-fixture.response"}],"name":"response","description":"A callback function that provides response information."},{"types":[{"type":"Object","options":[]}],"name":"requestHeaders","description":"Headers used to make the request."},{"types":[{"type":"Object","options":[]}],"name":"ajaxSettings","description":"The settings object used to match this request.\n"}]}],"_curParam":{"types":[{"type":"Object","options":[]}],"name":"ajaxSettings","description":"The settings object used to match this request.\n"},"pathToRoot":".."}; </script> </article> <footer><p>CanJS is part of <a href="http://donejs.com" target="_blank">DoneJS</a>. Created and maintained by the core <a href="https://donejs.com/About.html#section=section_Team" target="_blank">DoneJS team</a> and <a href="http://bitovi.com" target="_blank">Bitovi</a>. <strong>Currently 3.0.0.</strong></p></footer> </div> </div> </div> <script> steal = { instantiated: { "bundles/bit-docs-site/static.css!$css" : null } }; </script> <script type='text/javascript' data-main="bit-docs-site/static" src="./static/node_modules/steal/steal.production.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script> </body> </html>