Merge pull request #11 from JoschuaSchneider/move-to-typescript

Move to typescript

Author: Joschua Schneider

.github/workflows/npm-publish.yml

@@ -0,0 +1,32 @@
+# Publish package to npm on new release.
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.prettierrc

@@ -1,3 +1,3 @@
 {
   "semi": false
-}
+}

.travis.yml

@@ -16,6 +16,13 @@ It lets you keep track of the error state of child components, by wrapping them
 npm i use-error-boundary
 ```
 
+### Breaking changes in `2.x`
+
+If you are upgrading from version `1.x` please make sure you are not using the `errorInfo` object.
+The hook itself and the `renderError` callback no longer provide this object.
+
+For advanced use, please refer to [Custom handling of error and errorInfo](#custom-handling-of-error-and-errorinfo).
+
 ## Examples and usage
 
 Import the hook:
@@ -35,8 +42,7 @@ const MyComponent = () => {
   const {
     ErrorBoundary,
     didCatch,
-    error,
-    errorInfo
+    error
   } = useErrorBoundary()
 
   ...
@@ -85,11 +91,23 @@ Optionally, you can pass a `render` and `renderError` function to render the com
 return (
   <ErrorBoundary
     render={() => <SomeChild />}
-    renderError={({ error, errorInfo }) => <MyErrorComponent error={error} />}
+    renderError={({ error }) => <MyErrorComponent error={error} />}
   />
 )
 ```
 
+## Custom handling of `error` and `errorInfo`
+
+The hook now accepts an `options` object that you can pass a `onDidCatch` callback that gets called when the ErrorBoundary catches an error.
+
+```js
+useErrorBoundary({
+  onDidCatch: (error, errorInfo) => {
+    // For logging/reporting
+  },
+})
+```
+
 ## Returned Properties
 
 These are the properties of the returned Object:
@@ -99,7 +117,8 @@ These are the properties of the returned Object:
 | `ErrorBoundary` | React Component        | Special error boundary component that provides state changes to the hook. <br>:warning: **You need to use this as the error boundary! Otherwise, the state will not update when errors are catched!** <br> The ErrorBoundary is **guaranteed referential equality** across rerenders. |
 | `didCatch`      | Boolean                | `true` if an error has been catched                                                                                                                                                                                                                                                   |
 | `error`         | Error Object or `null` | The error catched by the Boundary                                                                                                                                                                                                                                                     |
-| `errorInfo`     | Object or `null`       | Error Info from the boundary ([React docs](https://reactjs.org/docs/error-boundaries.html))                                                                                                                                                                                           |
+
+If you are searching for the `errorInfo` property, please read [Breaking Changes in 2.x](#breaking-changes-in-2x).
 
 ## Why should I use this?
 
@@ -110,6 +129,6 @@ This packages purpose is to provide an easy drop in replacement for projects tha
 
 ## Contributing
 
-Contributions are welcome, as this is my **first properly published npm package**.
+Contributions are always welcome.
 
-Feel free to open issues or pull requests! I will review them as fast as possible.
+Feel free to open issues or pull requests!

README.md

@@ -0,0 +1,5 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "jsdom",
+  setupFilesAfterEnv: ["@testing-library/jest-dom/extend-expect"],
+}