Skip to content

Latest commit

 

History

History

error-boundary-jsx

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

npm npm bundle size Build Status codecov dependabot badge semantic-release Commitizen friendly

error-boundary-jsx

Handle errors on wrapped component and provide a fall back.

yarn add error-boundary-jsx

# or with npm

npm install error-boundary-jsx --save

<ErrorBoundary /> Component (Recommended)

Handle errors for specific use case of component.

import ErrorBoundary from 'error-boundary-jsx'

<ErrorBoundary onError={componentErrorHandler} name="component name" FallbackComponent={CustomFallbackComponent}>
    ...component tree to handle errors
</ErrorBoundary>

withErrorBoundary() HOC

HOC for error handling every use case of a component.

import withErrorBoundary from 'error-boundary-jsx'

const componentErrorHandler = {
    handleComponentError(error: Error, name: string, stack: string): void {
        ...log error
    }
}

withErrorBoundary(Component, componentErrorHandler)
API
prop type required defaultValue Description
component React.ComponentType true - A component that we want to bind error boundary jsx to
name string true - Component name to identify in stack message
onError (name: string, error: Error, stack: string) => void true - Error callback handler
FallbackComponent React.ComponentType false - A fallback component when error occurs