Skip to main content

Class: ErrorBoundary

@ima/react-page-renderer.ErrorBoundary

Error boundary wrapper which connects the IMA application to the dev HMR api and handles error reporting.

Hierarchy​

  • PureComponent\<ErrorBoundaryProps, ErrorBoundaryState>

    ↳ ErrorBoundary

Constructors​

constructor​

• new ErrorBoundary(props)

Parameters​

NameType
propsErrorBoundaryProps

Overrides​

PureComponent\< ErrorBoundaryProps, ErrorBoundaryState \>.constructor

Defined in​

packages/react-page-renderer/src/component/ErrorBoundary.ts:19

Properties​

context​

• context: unknown

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

Example

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>

See

React Docs

Inherited from​

PureComponent.context

Defined in​

node_modules/@types/react/index.d.ts:1006

props​

• Readonly props: Readonly\<ErrorBoundaryProps>

Inherited from​

PureComponent.props

Defined in​

node_modules/@types/react/index.d.ts:1026

refs​

• refs: Object

Deprecated

See

Legacy React Docs

Index signature​

▪ [key: string]: ReactInstance

Inherited from​

PureComponent.refs

Defined in​

node_modules/@types/react/index.d.ts:1033

state​

• state: Readonly\<ErrorBoundaryState>

Inherited from​

PureComponent.state

Defined in​

node_modules/@types/react/index.d.ts:1027

contextType​

▪ Static Optional contextType: Context\<any>

If set, this.context will be set at runtime to the current value of the given Context.

Example

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}

See

https://react.dev/reference/react/Component#static-contexttype

Inherited from​

PureComponent.contextType

Defined in​

node_modules/@types/react/index.d.ts:988

Methods​

UNSAFE_componentWillMount​

▸ Optional UNSAFE_componentWillMount(): void

Called immediately before mounting occurs, and before render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Returns​

void

Deprecated

16.3, use componentDidMount or the constructor instead

See

Inherited from​

PureComponent.UNSAFE_componentWillMount

Defined in​

node_modules/@types/react/index.d.ts:1463

UNSAFE_componentWillReceiveProps​

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling setState generally does not trigger this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters​

NameType
nextPropsReadonly\<ErrorBoundaryProps>
nextContextany

Returns​

void

Deprecated

16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead

See

Inherited from​

PureComponent.UNSAFE_componentWillReceiveProps

Defined in​

node_modules/@types/react/index.d.ts:1497

UNSAFE_componentWillUpdate​

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call setState here.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters​

NameType
nextPropsReadonly\<ErrorBoundaryProps>
nextStateReadonly\<ErrorBoundaryState>
nextContextany

Returns​

void

Deprecated

16.3, use getSnapshotBeforeUpdate instead

See

Inherited from​

PureComponent.UNSAFE_componentWillUpdate

Defined in​

node_modules/@types/react/index.d.ts:1527

componentDidCatch​

▸ componentDidCatch(error): void

Parameters​

NameType
errorError

Returns​

void

Overrides​

PureComponent.componentDidCatch

Defined in​

packages/react-page-renderer/src/component/ErrorBoundary.ts:38

componentDidMount​

▸ componentDidMount(): void

Returns​

void

Overrides​

PureComponent.componentDidMount

Defined in​

packages/react-page-renderer/src/component/ErrorBoundary.ts:31

componentDidUpdate​

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): void

Called immediately after updating occurs. Not called for the initial render.

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

Parameters​

NameType
prevPropsReadonly\<ErrorBoundaryProps>
prevStateReadonly\<ErrorBoundaryState>
snapshot?any

Returns​

void

Inherited from​

PureComponent.componentDidUpdate

Defined in​

node_modules/@types/react/index.d.ts:1432

componentWillMount​

▸ Optional componentWillMount(): void

Called immediately before mounting occurs, and before render. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Returns​

void

Deprecated

16.3, use componentDidMount or the constructor instead; will stop working in React 17

See

Inherited from​

PureComponent.componentWillMount

Defined in​

node_modules/@types/react/index.d.ts:1448

componentWillReceiveProps​

▸ Optional componentWillReceiveProps(nextProps, nextContext): void

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling setState generally does not trigger this method.

Note: the presence of getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters​

NameType
nextPropsReadonly\<ErrorBoundaryProps>
nextContextany

Returns​

void

Deprecated

16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead; will stop working in React 17

See

Inherited from​

PureComponent.componentWillReceiveProps

Defined in​

node_modules/@types/react/index.d.ts:1479

componentWillUnmount​

▸ Optional componentWillUnmount(): void

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

Returns​

void

Inherited from​

PureComponent.componentWillUnmount

Defined in​

node_modules/@types/react/index.d.ts:1385

componentWillUpdate​

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call setState here.

Note: the presence of getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters​

NameType
nextPropsReadonly\<ErrorBoundaryProps>
nextStateReadonly\<ErrorBoundaryState>
nextContextany

Returns​

void

Deprecated

16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

See

Inherited from​

PureComponent.componentWillUpdate

Defined in​

node_modules/@types/react/index.d.ts:1511

forceUpdate​

▸ forceUpdate(callback?): void

Parameters​

NameType
callback?() => void

Returns​

void

Inherited from​

PureComponent.forceUpdate

Defined in​

node_modules/@types/react/index.d.ts:1023

getSnapshotBeforeUpdate​

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

Note: the presence of this method prevents any of the deprecated lifecycle events from running.

Parameters​

NameType
prevPropsReadonly\<ErrorBoundaryProps>
prevStateReadonly\<ErrorBoundaryState>

Returns​

any

Inherited from​

PureComponent.getSnapshotBeforeUpdate

Defined in​

node_modules/@types/react/index.d.ts:1426

render​

▸ render(): undefined | null | ReactElement\<any, string | JSXElementConstructor\<any>>

Returns​

undefined | null | ReactElement\<any, string | JSXElementConstructor\<any>>

Overrides​

PureComponent.render

Defined in​

packages/react-page-renderer/src/component/ErrorBoundary.ts:45

setState​

▸ setState\<K>(state, callback?): void

Type parameters​

NameType
Kextends "hasError"

Parameters​

NameType
statenull | ErrorBoundaryState | (prevState: Readonly\<ErrorBoundaryState>, props: Readonly\<ErrorBoundaryProps>) => null | ErrorBoundaryState | Pick\<ErrorBoundaryState, K> | Pick\<ErrorBoundaryState, K>
callback?() => void

Returns​

void

Inherited from​

PureComponent.setState

Defined in​

node_modules/@types/react/index.d.ts:1018

shouldComponentUpdate​

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

Called to determine whether the change in props and state should trigger a re-render.

Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

If false is returned, render, componentWillUpdate and componentDidUpdate will not be called.

Parameters​

NameType
nextPropsReadonly\<ErrorBoundaryProps>
nextStateReadonly\<ErrorBoundaryState>
nextContextany

Returns​

boolean

Inherited from​

PureComponent.shouldComponentUpdate

Defined in​

node_modules/@types/react/index.d.ts:1380

getDerivedStateFromError​

▸ Static getDerivedStateFromError(): Object

Returns​

Object

NameType
hasErrorboolean

Defined in​

packages/react-page-renderer/src/component/ErrorBoundary.ts:27