@weser/errors 0.0.14 → 0.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -39
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,41 +1,3 @@
|
|
|
1
1
|
# @weser/errors
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
```sh
|
|
8
|
-
# npm
|
|
9
|
-
npm i --save @weser/errors
|
|
10
|
-
# yarn
|
|
11
|
-
yarn add @weser/errors
|
|
12
|
-
# pnpm
|
|
13
|
-
pnpm add @weser/errors
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Documentation
|
|
17
|
-
|
|
18
|
-
### invariant
|
|
19
|
-
|
|
20
|
-
#### Parameters
|
|
21
|
-
|
|
22
|
-
| Parameter | Type | Description |
|
|
23
|
-
| --------- | --------- | -------------------------------- |
|
|
24
|
-
| condition | `boolean` | A condition that throws if false |
|
|
25
|
-
| message | string | The error message that is thrown |
|
|
26
|
-
|
|
27
|
-
```tsx
|
|
28
|
-
import { invariant } from '@weser/errors'
|
|
29
|
-
|
|
30
|
-
function login(email: string, password: string) {
|
|
31
|
-
invariant(password.length < 8, 'The password needs to be at least 8 letters.')
|
|
32
|
-
|
|
33
|
-
// do actual login
|
|
34
|
-
}
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
## License
|
|
38
|
-
|
|
39
|
-
@weser/errors is licensed under the [MIT License](http://opensource.org/licenses/MIT).<br>
|
|
40
|
-
Documentation is licensed under [Creative Common License](http://creativecommons.org/licenses/by/4.0/).<br>
|
|
41
|
-
Created with ♥ by [@robinweser](http://weser.io).
|
|
3
|
+
[Documentation](https://packages.weser.io/errors)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@weser/errors",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.15",
|
|
4
4
|
"description": "Tiny helpers for error handling",
|
|
5
5
|
"author": "Robin Weser <robin@weser.io>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,5 +45,5 @@
|
|
|
45
45
|
"rimraf": "^3.0.2",
|
|
46
46
|
"typescript": "^5.4.5"
|
|
47
47
|
},
|
|
48
|
-
"gitHead": "
|
|
48
|
+
"gitHead": "09f1d19b11a34e519fd35cf91cede2b75f38356c"
|
|
49
49
|
}
|