Skip to content

Commit

Permalink
Remove outdated info from README, pump version
Browse files Browse the repository at this point in the history
  • Loading branch information
Siegrift committed Jun 5, 2019
1 parent c3eeee0 commit bb6a1b4
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 15 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,7 @@ There are many advantages of this helper:
- The path can be autocompleted and must be able to exist in the object
- Handles arrays, optional and nullable values (even in intermediate objects)

![Strongly typed get helper](assets/good_set.png)
_After a value is set on a path, you don't need to use `!` on optional values, because the values
along the path have been created._

![Strongly typed get helper](assets/good_update.png)
![Update helper](assets/good_update.png)
_When you call update for the first time, `value` in update function can be `undefined` (if any
intermediate value doesn't exist). However, when calling it for a second time, it is guaranteed that
the values on the path exist._
Expand Down
Binary file removed assets/good_set.png
Binary file not shown.
Binary file removed docs/assets/good_set.png
Binary file not shown.
5 changes: 1 addition & 4 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,7 @@ <h2 id="motivation">Motivation</h2>
<li>The path can be autocompleted and must be able to exist in the object</li>
<li>Handles arrays, optional and nullable values (even in intermediate objects)</li>
</ul>
<p><img src="assets/good_set.png" alt="Strongly typed get helper">
<em>After a value is set on a path, you don&#39;t need to use <code>!</code> on optional values, because the values
along the path have been created.</em></p>
<p><img src="assets/good_update.png" alt="Strongly typed get helper">
<p><img src="assets/good_update.png" alt="Update helper">
<em>When you call update for the first time, <code>value</code> in update function can be <code>undefined</code> (if any
intermediate value doesn&#39;t exist). However, when calling it for a second time, it is guaranteed that
the values on the path exist.</em></p>
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@siegrift/tsfunct",
"version": "1.2.0",
"version": "1.2.1",
"repository": {
"type": "git",
"url": "git+https://github.com/Siegrift/tsfunct.git"
Expand All @@ -15,7 +15,7 @@
"devDependencies": {
"@types/jest": "^24.0.13",
"@types/node": "^12.0.2",
"husky": "^2.3.0",
"husky": "^2.4.0",
"jest": "^24.8.0",
"ts-jest": "^24.0.2",
"tslint": "^5.16.0",
Expand Down
8 changes: 4 additions & 4 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -1516,10 +1516,10 @@ http-signature@~1.2.0:
jsprim "^1.2.2"
sshpk "^1.7.0"

husky@^2.3.0:
version "2.3.0"
resolved "https://registry.yarnpkg.com/husky/-/husky-2.3.0.tgz#8b78ed24d763042df7fd899991985d65a976dd13"
integrity sha512-A/ZQSEILoq+mQM3yC3RIBSaw1bYXdkKnyyKVSUiJl+iBjVZc5LQEXdGY1ZjrDxC4IzfRPiJ0IqzEQGCN5TQa/A==
husky@^2.4.0:
version "2.4.0"
resolved "https://registry.yarnpkg.com/husky/-/husky-2.4.0.tgz#1bac7c44588f6e91f808b72efc82d24a57194f36"
integrity sha512-3k1wuZU20gFkphNWMjh2ISCFaqfbaLY7R9FST2Mj9HeRhUK9ydj9qQR8qfXlog3EctVGsyeilcZkIT7uBZDDVA==
dependencies:
cosmiconfig "^5.2.0"
execa "^1.0.0"
Expand Down

0 comments on commit bb6a1b4

Please sign in to comment.