summaryrefslogtreecommitdiff
path: root/http/README.md
diff options
context:
space:
mode:
authorStoyan Dimkov <stoyan.dimkov@gmail.com>2019-05-23 19:05:00 +0300
committerRyan Dahl <ry@tinyclouds.org>2019-05-23 19:05:00 +0300
commit73f7be6ae0963548251b720465ea19802015901a (patch)
tree015a898df2c919d80c72a9967b9ae7e6c0a296c1 /http/README.md
parent632fbd7734e4c0662a1673b537def5fe474dece2 (diff)
Fix http README examples (denoland/deno_std#440)
Some cosmetic fixes to the provided examples in the http README: - Ensure they're all actually runnable - Use clear variable names - Add usage of Cookie interface Original: https://github.com/denoland/deno_std/commit/b9b25b8b17f8ca952392315f6b4f0dcfa5c5a00a
Diffstat (limited to 'http/README.md')
-rw-r--r--http/README.md36
1 files changed, 23 insertions, 13 deletions
diff --git a/http/README.md b/http/README.md
index c7bac3f09..959afe568 100644
--- a/http/README.md
+++ b/http/README.md
@@ -7,36 +7,46 @@ A framework for creating HTTP/HTTPS server.
Helper to manipulate `Cookie` throught `ServerRequest` and `Response`.
```ts
+import { ServerRequest } from "https://deno.land/std/http/server.ts";
import { getCookies } from "https://deno.land/std/http/cookie.ts";
-let req = new ServerRequest();
-req.headers = new Headers();
-req.headers.set("Cookie", "full=of; tasty=chocolate");
+let request = new ServerRequest();
+request.headers = new Headers();
+request.headers.set("Cookie", "full=of; tasty=chocolate");
-const c = getCookies(request);
-// c = { full: "of", tasty: "chocolate" }
+const cookies = getCookies(request);
+console.log("cookies:", cookies);
+// cookies: { full: "of", tasty: "chocolate" }
```
To set a `Cookie` you can add `CookieOptions` to properly set your `Cookie`
```ts
-import { setCookie } from "https://deno.land/std/http/cookie.ts";
+import { Response } from "https://deno.land/std/http/server.ts";
+import { Cookie, setCookie } from "https://deno.land/std/http/cookie.ts";
-let res: Response = {};
-res.headers = new Headers();
-setCookie(res, { name: "Space", value: "Cat" });
+let response: Response = {};
+const cookie: Cookie = { name: "Space", value: "Cat" };
+setCookie(response, cookie);
+
+const cookieHeader = response.headers.get("set-cookie");
+console.log("Set-Cookie:", cookieHeader);
+// Set-Cookie: Space=Cat
```
Deleting a `Cookie` will set its expiration date before now.
Forcing the browser to delete it.
```ts
+import { Response } from "https://deno.land/std/http/server.ts";
import { delCookie } from "https://deno.land/std/http/cookie.ts";
-let res = new Response();
-delCookie(res, "deno");
-// Will append this header in the response
-// "Set-Cookie: deno=; Expires=Thus, 01 Jan 1970 00:00:00 GMT"
+let response: Response = {};
+delCookie(response, "deno");
+
+const cookieHeader = response.headers.get("set-cookie");
+console.log("Set-Cookie:", cookieHeader);
+// Set-Cookie: deno=; Expires=Thus, 01 Jan 1970 00:00:00 GMT
```
**Note**: At the moment multiple `Set-Cookie` in a `Response` is not handled.