|
1 | 1 | # Router
|
2 |
| -API Router for Readable Code |
| 2 | + |
| 3 | +API Router for Readable Code. |
| 4 | +## Table of Contents |
| 5 | + |
| 6 | + - [Features](#features) |
| 7 | + - [Browser Support](#browser-support) |
| 8 | + - [Installing](#installing) |
| 9 | + - [Example](#example) |
| 10 | + |
| 11 | +## Features |
| 12 | +- mostly covered basic HTTP method |
| 13 | +- provide method which make payload resource for HTTP client |
| 14 | +- easily set and override HTTP client configuration with less code |
| 15 | +- modify partially basic routing configuration with builder pattern |
| 16 | + |
| 17 | +## Browser Support |
| 18 | + |
| 19 | + |  |  |  |  |  | |
| 20 | +--- | --- | --- | --- | --- | --- | |
| 21 | +Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 11 ✔ | |
| 22 | + |
| 23 | +## Installing |
| 24 | + |
| 25 | +Using npm: |
| 26 | + |
| 27 | +```bash |
| 28 | +$ npm install @coldbrew/router |
| 29 | +``` |
| 30 | + |
| 31 | +Using yarn: |
| 32 | + |
| 33 | +```bash |
| 34 | +$ yarn add @coldbrew/router |
| 35 | +``` |
| 36 | + |
| 37 | +## Example |
| 38 | + |
| 39 | +Performing a `GET` request |
| 40 | + |
| 41 | +```typescript |
| 42 | +import { Router } from '@coldbrew/router'; |
| 43 | + |
| 44 | +const router = new Router(); |
| 45 | + |
| 46 | +// Make a request with callback pattern |
| 47 | +router.uri('/user?id=12345') |
| 48 | + .get((err: RouterError, response: RouterResponse) => { |
| 49 | + if (err) { |
| 50 | + console.log('err:', err.response); |
| 51 | + } |
| 52 | + |
| 53 | + console.log(response.data); |
| 54 | + }); |
| 55 | + |
| 56 | +// Make a request with promise pattern |
| 57 | +router.uri('/user?id=12345') |
| 58 | + .get() |
| 59 | + .then((response: RouterResponse) => { |
| 60 | + console.log(response.data.length); |
| 61 | + }) |
| 62 | + .catch((err: RouterError) => { |
| 63 | + console.log(err.response); |
| 64 | + }); |
| 65 | + |
| 66 | +// Make a request with async/await pattern |
| 67 | +async function getUser() { |
| 68 | + try { |
| 69 | + const results: RouterResponse = await router.uri('/user?id=12345').get(); |
| 70 | + } catch (e) { |
| 71 | + console.log(e.response.data); |
| 72 | + } |
| 73 | +} |
| 74 | +``` |
| 75 | + |
| 76 | +> **NOTE:** `async/await` is part of ECMAScript 2017 and is not supported in Internet |
| 77 | +> Explorer and older browsers, so use with caution. |
| 78 | +
|
| 79 | +Performing a `POST` request |
| 80 | + |
| 81 | +```typescript |
| 82 | + |
| 83 | +``` |
| 84 | + |
| 85 | +Performing multiple concurrent requests |
| 86 | + |
| 87 | +```typescript |
| 88 | + |
| 89 | +``` |
0 commit comments