8000 docs: improvements worthy of release 0.4.6 · angular/in-memory-web-api@22c2d97 · GitHub
[go: up one dir, main page]
Skip to content
This repository was archived by the owner on Feb 26, 2024. It is now read-only.

Commit 22c2d97

Browse files
wardbellwardbell
committed
docs: improvements worthy of release 0.4.6
1 parent dea9a2d commit 22c2d97

File tree

3 files changed

+38
-20
lines changed

3 files changed

+38
-20
lines changed

‎CHANGELOG.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ because this is a development tool, not a production product.
88
We do try to tell you about such changes in this `CHANGELOG.md`
99
and we fix bugs as fast as we can.
1010

11+
<a id="0.4.6"></a>
12+
## 0.4.6 (2017-09-13)
13+
- improves README
14+
- updates v0.4.0 entry in the CHANGELOG to describe essential additions to SystemJS configuration.
15+
- no important functional changes.
16+
1117
<a id="0.4.5"></a>
1218
## 0.4.5 (2017-09-11)
1319
Feature - offer separate `HttpClientInMemoryWebApiModule` and `HttpInMemoryWebApiModule`.
@@ -61,6 +67,8 @@ See PR #130.
6167
Many low-level and customization options have changed.
6268
Apps that stuck with defaults should be (mostly) OK.
6369

70+
If you're loading application files with **SystemJS** (as you would in a plunker), see the [instructions below](#v-0-4-systemjs).
71+
6472
* added support for `HttpClient` -> renaming of backend service classes
6573
* added tests
6674
* refactor existing code to support tests
@@ -79,6 +87,31 @@ to arbitrary initial states (issue #128)
7987
* reorganize files into src/app and src/in-mem
8088
* adjust gulp tasks accordingly
8189

90+
---
91+
92+
<a id="v-0-4-systemjs"></a>
93+
### Plunkers and SystemJS
94+
95+
If you’re loading application files with **SystemJS** (as you would in a plunker), you’ll have to configure it to load Angular’s `umd.js` for `HttpModule` and the `tslib` package.
96+
97+
To see how, look in the `map` section of the
98+
[`src/systemjs.config.js` for this project](https://github.com/angular/in-memory-web-api/blob/master/src/systemjs.config.js) for the following two _additional_ lines :
99+
100+
```
101+
'@angular/common/http': 'npm:@angular/common/bundles/common-http.umd.js',
102+
...
103+
'tslib': 'npm:tslib/tslib.js',
104+
105+
```
106+
107+
You've already made these changes if you are using `HttpClient` today.
108+
109+
If you’re sticking with the original Angular `Http` module, you _must make this change anyway!_ Your app will break as soon as you run `npm install` and it installs >=v0.4.0.
110+
111+
If you're using webpack (as CLI devs do), you don't have to worry about this stuff because webpack bundles the dependencies for you.
112+
113+
---
114+
82115
<a id="0.3.2"></a>
83116
## 0.3.2 (2017-05-02)
84117
* Bug fixes PRs #91, 95, 106

‎README.md

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,12 @@ It intercepts Angular `Http` and `HttpClient` requests that would otherwise go t
1313
>You don't have to change your existing application _code_ if your app uses this library without customizations.
1414
>
1515
>
16-
>The v0.4.0 release introduced *breaking changes* that affect developers who used the customization features.
17-
>We're pretty sure you'll think these changes are worthwhile.
16+
>The v0.4.0 release introduced **breaking changes** that affect developers who used the customization features or loaded application files with SystemJS.
1817
>
19-
>**Read this README** and the [CHANGELOG](https://github.com/angular/in-memory-web-api/blob/master/CHANGELOG.md)
20-
to learn what's new.
21-
>The new unit tests are worth a look as well.
18+
>**Read this README and the [CHANGELOG](https://github.com/angular/in-memory-web-api/blob/master/CHANGELOG.md/#0.4.0)**
19+
to learn what's new and about **breaking changes**
2220
>
23-
---
24-
>If you’re loading application files with **SystemJS**, you’ll have to configure it to load Angular’s `umd.js` for `HttpModule`.
25-
>To see how, look for the following line in the
26-
>`src/systemjs.config.js` of this project:
27-
>
28-
>`'@angular/common/http': 'npm:@angular/common/bundles/common-http.umd.js'`
29-
>
30-
>You've already made this change if you are using `HttpClient` today.
31-
>
32-
>If you’re sticking with the original Angular `Http` module, you _must make this change anyway!_ Your app will break as soon as you run `npm install` and it installs >=v0.4.0.
33-
>
34-
>If you're using webpack (as CLI devs do), you don't have to worry about this stuff because webpack bundles the dependencies for you.
35-
36-
---
21+
>The new **unit tests** are a good way to see the in-memory web api in action.
3722
3823
## Use cases
3924

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "angular-in-memory-web-api",
3-
"version": "0.4.5",
3+
"version": "0.4.6",
44
"description": "An in-memory web api for Angular demos and tests",
55
"main": "bundles/in-memory-web-api.umd.js",
66
"module": "index.js",

0 commit comments

Comments
 (0)
0