294 lines
8.2 KiB
HTML
294 lines
8.2 KiB
HTML
<!doctype html>
|
|
<html lang='en' class='no-js '>
|
|
<head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta charset='utf-8'>
|
|
<meta content='width=device-width, initial-scale=1.0' name='viewport'>
|
|
<link href='./assets/favicon.png' rel='shortcut icon'>
|
|
<meta content='/koa.html' name='app:pageurl'>
|
|
|
|
|
|
<title>Koa cheatsheet</title>
|
|
<meta content='Koa cheatsheet' property='og:title'>
|
|
<meta content='Koa cheatsheet' property='twitter:title'>
|
|
<meta content='article' property='og:type'>
|
|
|
|
|
|
|
|
<meta content='https://assets.devhints.io/previews/koa.jpg?t=20210927011516' property='og:image'>
|
|
<meta content='https://assets.devhints.io/previews/koa.jpg?t=20210927011516' property='twitter:image'>
|
|
<meta content='900' property='og:image:width'>
|
|
<meta content='471' property='og:image:height'>
|
|
|
|
|
|
|
|
<meta content="The one-page guide to Koa: usage, examples, links, snippets, and more." name="description">
|
|
<meta content="The one-page guide to Koa: usage, examples, links, snippets, and more." property="og:description">
|
|
<meta content="The one-page guide to Koa: usage, examples, links, snippets, and more." property="twitter:description">
|
|
|
|
|
|
<link rel="canonical" href="https://devhints.io/koa">
|
|
<meta name="og:url" content="https://devhints.io/koa">
|
|
|
|
|
|
|
|
|
|
|
|
<meta content='Devhints.io cheatsheets' property='og:site_name'>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta content='JavaScript libraries' property='article:section'>
|
|
|
|
|
|
|
|
|
|
|
|
<script async src='https://www.googletagmanager.com/gtag/js?id=UA-106902774-1'></script>
|
|
<script>
|
|
|
|
window.dataLayer=window.dataLayer||[];
|
|
function gtag(){dataLayer.push(arguments)};
|
|
gtag('js',new Date());
|
|
gtag('config','UA-106902774-1');
|
|
</script>
|
|
|
|
|
|
|
|
<meta property='page:depth' content='1'>
|
|
|
|
|
|
<script>(function(H){H.className=H.className.replace(/\bno-js\b/,'js')})(document.documentElement)</script>
|
|
<script>(function(H){H.className=H.className.replace(/\bNoJs\b/,'WithJs')})(document.documentElement)</script>
|
|
|
|
<script>(function(d,s){if(window.Promise&&[].includes&&Object.assign&&window.Map)return;var js,sc=d.getElementsByTagName(s)[0];js=d.createElement(s);js.src='https://cdn.polyfill.io/v2/polyfill.min.js';sc.parentNode.insertBefore(js, sc);}(document,'script'))</script>
|
|
|
|
<!--[if lt IE 9]><script src='https://cdnjs.cloudflare.com/ajax/libs/nwmatcher/1.2.5/nwmatcher.min.js'></script><script src='https://cdnjs.cloudflare.com/ajax/libs/json2/20140204/json2.js'></script><script src='https://cdn.rawgit.com/gisu/selectivizr/1.0.3/selectivizr.js'></script><script src='https://cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js'></script><script src='https://cdnjs.cloudflare.com/ajax/libs/respond.js/1.4.2/respond.js'></script><![endif]-->
|
|
|
|
<style>html{opacity:0}</style>
|
|
<link rel="stylesheet" href="./assets/2015/style.css?t=20210927011516">
|
|
<link href="./assets/style.css?t=20210927011516" rel="stylesheet" />
|
|
<link href="./assets/print.css?t=20210927011516" rel="stylesheet" media="print" />
|
|
</head>
|
|
<body>
|
|
<div class='all'>
|
|
|
|
<div class='site-header'>
|
|
<div class='container'>
|
|
This is <a href="."><em>Devhints.io cheatsheets</em></a> — a collection of cheatsheets I've written.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<script type='application/ld+json'>
|
|
{
|
|
"@context": "http://schema.org",
|
|
"@type": "NewsArticle",
|
|
"mainEntityOfPage": {
|
|
"@type": "WebPage",
|
|
"@id": "https://google.com/article"
|
|
},
|
|
"headline": "Koa cheatsheet",
|
|
"image": [ "https://assets.devhints.io/previews/koa.jpg?t=20210927011516" ],
|
|
"description": "The one-page guide to Koa: usage, examples, links, snippets, and more."
|
|
}
|
|
</script>
|
|
<script type='application/ld+json'>
|
|
{
|
|
"@context": "http://schema.org",
|
|
"@type": "BreadcrumbList",
|
|
"itemListElement": [{
|
|
"@type": "ListItem",
|
|
"position": 1,
|
|
"item": {
|
|
"@id": "https://devhints.io/#javascript-libraries",
|
|
"name": "JavaScript libraries"
|
|
}
|
|
},{
|
|
"@type": "ListItem",
|
|
"position": 2,
|
|
"item": {
|
|
"@id": "https://devhints.io/koa",
|
|
"name": "Koa"
|
|
}
|
|
}]
|
|
}
|
|
</script>
|
|
|
|
|
|
<div class='post-list -single -cheatsheet'>
|
|
<div class='post-item'>
|
|
<div class='post-headline -cheatsheet'>
|
|
<p class='prelude'><span></span></p>
|
|
<h1><span>Koa</span></h1>
|
|
|
|
<div class='pubbox'>
|
|
<div class='HeadlinePub' role='complementary'>
|
|
<script async src='https://pubsrv.devhints.io/carbon.js?serve=CE7IK5QM&placement=devhintsio&cd=pubsrv.devhints.io/s' id="_carbonads_js"></script>
|
|
<span class='placeholder -one'></span>
|
|
<span class='placeholder -two'></span>
|
|
<span class='placeholder -three'></span>
|
|
<span class='placeholder -four'></span>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class='post-content -cheatsheet'>
|
|
<h3 id="reference">Reference</h3>
|
|
|
|
<pre><code class="language-js">app.use(function * (next) {
|
|
var ctx = this
|
|
|
|
ctx.request
|
|
ctx.response
|
|
|
|
ctx.body = 'hello'
|
|
|
|
ctx.state.user = yield User.find(id).fetch()
|
|
|
|
ctx.cookies.set('foo', 'hello', { signed: true })
|
|
ctx.cookies.get('foo')
|
|
|
|
ctx.throw(403)
|
|
</code></pre>
|
|
|
|
<h3 id="request">Request</h3>
|
|
|
|
<pre><code class="language-js"> ctx.header // ctx.headers
|
|
ctx.method // and =
|
|
ctx.url // and =
|
|
ctx.originalUrl
|
|
ctx.origin // => 'http://example.com'
|
|
ctx.href // => 'http://example.com/foo?q=hello'
|
|
ctx.path // and =
|
|
ctx.query // { q: 'hello' }
|
|
ctx.query // and =
|
|
ctx.querystring
|
|
ctx.querystring // and =
|
|
ctx.host
|
|
ctx.hostname
|
|
ctx.fresh
|
|
ctx.stale
|
|
ctx.socket
|
|
ctx.protocol
|
|
ctx.secure
|
|
ctx.ip
|
|
ctx.ips
|
|
ctx.subdomains
|
|
ctx.is() // .is('html') .is('text/html')
|
|
ctx.accepts() // .accepts('html') .accepts('html', 'json')
|
|
ctx.acceptsEncodings() // .acceptsEncodings('gzip')
|
|
ctx.acceptsCharsets()
|
|
ctx.acceptsLanguages()
|
|
ctx.get()
|
|
|
|
ctx.request.type // => 'image/jpg'
|
|
ctx.request.charset // => 'utf-8'
|
|
ctx.request.protocol // => 'https'
|
|
ctx.request.secure // => true
|
|
ctx.request.ip // (supports X-Forwarded-For if app.proxy)
|
|
ctx.request.ips
|
|
ctx.request.subdomains
|
|
|
|
ctx.request.fresh
|
|
ctx.request.stale
|
|
</code></pre>
|
|
|
|
<h3 id="response">Response</h3>
|
|
|
|
<pre><code class="language-js"> ctx.body = 'hello'
|
|
|
|
ctx.throw(403)
|
|
ctx.throw('name required', 403)
|
|
ctx.throw(403, 'name required')
|
|
ctx.throw('oops')
|
|
ctx.assert(ctx.state.user, 401, 'You must log in')
|
|
</code></pre>
|
|
|
|
<h3 id="middlewares">Middlewares</h3>
|
|
|
|
<pre><code class="language-js">exports.conditionalGet = require('koa-conditional-get');
|
|
exports.responseTime = require('koa-response-time');
|
|
exports.ratelimit = require('koa-ratelimit');
|
|
exports.compress = require('koa-compress');
|
|
exports.rewrite = require('koa-rewrite');
|
|
exports.favicon = require('koa-favicon');
|
|
exports.session = require('koa-session');
|
|
exports.static = require('koa-static');
|
|
exports.logger = require('koa-logger');
|
|
exports.mount = require('koa-mount');
|
|
exports.etag = require('koa-etag');
|
|
</code></pre>
|
|
|
|
</div>
|
|
|
|
|
|
<ul class="social-list ">
|
|
<li class="facebook link hint--bottom" data-hint="Share on Facebook"><a href="https://www.facebook.com/sharer/sharer.php?u=https://devhints.io/koa.html" target="share"><span class="text"></span></a></li>
|
|
<li class="twitter link hint--bottom" data-hint="Share on Twitter"><a href="https://twitter.com/intent/tweet?text=The%20ultimate%20cheatsheet%20for%20Koa.%20https://devhints.io/koa.html" target="share"><span class="text"></span></a></li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="about-the-site">
|
|
<div class="container">
|
|
<p class='blurb'>
|
|
<strong><a href=".">Devhints.io cheatsheets</a></strong> is a collection of cheatsheets I've written over the years.
|
|
Suggestions and corrections? <a href='https://github.com/rstacruz/cheatsheets/issues/907'>Send them in</a>.
|
|
<i class='fleuron'></i>
|
|
I'm <a href="http://ricostacruz.com">Rico Sta. Cruz</a>.
|
|
Check out my <a href="http://ricostacruz.com/til">Today I learned blog</a> for more.
|
|
</p>
|
|
|
|
|
|
<p class='back'>
|
|
<a class='big-button -back -slim' href='.#toc'></a>
|
|
</p>
|
|
|
|
|
|
<p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.5/highlight.min.js"></script>
|
|
|
|
|
|
|
|
|
|
<script src="https://cdn.rawgit.com/rstacruz/unorphan/v1.0.1/index.js"></script>
|
|
<script>hljs.initHighlightingOnLoad()</script>
|
|
<script>unorphan('h1, h2, h3, p, li, .unorphan')</script>
|
|
|
|
</body>
|
|
</html>
|
|
|