Class: AppErrorBoundary
Hierarchy
Component<AppErrorBoundaryProps,AppErrorBoundaryState>↳
AppErrorBoundary
Constructors
constructor
• new AppErrorBoundary(props)
Parameters
| Name | Type |
|---|---|
props | AppErrorBoundaryProps |
Overrides
React.Component<AppErrorBoundaryProps, AppErrorBoundaryState\>.constructor
Defined in
onekijs/packages/onekijs-framework/src/app/AppErrorBoundary.tsx:17
Properties
context
• context: any
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.
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 https://reactjs.org/docs/context.html
Inherited from
React.Component.context
Defined in
onekijs/node_modules/@types/react/index.d.ts:473
props
• Readonly props: Readonly<AppErrorBoundaryProps> & Readonly<Object>
Inherited from
React.Component.props
Defined in
onekijs/node_modules/@types/react/index.d.ts:498
refs
• refs: Object
deprecated
https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs
Index signature
▪ [key: string]: ReactInstance
Inherited from
React.Component.refs
Defined in
onekijs/node_modules/@types/react/index.d.ts:504
state
• state: Readonly<AppErrorBoundaryState>
Inherited from
React.Component.state
Defined in
onekijs/node_modules/@types/react/index.d.ts:499
contextType
▪ Static Optional contextType: Context<any>
If set, this.context will be set at runtime to the current value of the given Context.
Usage:
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://reactjs.org/docs/context.html#classcontexttype
Inherited from
React.Component.contextType
Defined in
onekijs/node_modules/@types/react/index.d.ts:455
Methods
UNSAFE_componentWillMount
▸ Optional UNSAFE_componentWillMount(): void
Called immediately before mounting occurs, and before Component#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 getDerivedStateFromProps prevents this from being invoked.
deprecated 16.3, use componentDidMount or the constructor instead
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Returns
void
Inherited from
React.Component.UNSAFE_componentWillMount
Defined in
onekijs/node_modules/@types/react/index.d.ts:711
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 Component#setState generally does not trigger this method.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
deprecated 16.3, use static getDerivedStateFromProps instead
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters
| Name | Type |
|---|---|
nextProps | Readonly<AppErrorBoundaryProps> |
nextContext | any |
Returns
void
Inherited from
React.Component.UNSAFE_componentWillReceiveProps
Defined in
onekijs/node_modules/@types/react/index.d.ts:743
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 Component#setState here.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
deprecated 16.3, use getSnapshotBeforeUpdate instead
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters
| Name | Type |
|---|---|
nextProps | Readonly<AppErrorBoundaryProps> |
nextState | Readonly<AppErrorBoundaryState> |
nextContext | any |
Returns
void
Inherited from
React.Component.UNSAFE_componentWillUpdate
Defined in
onekijs/node_modules/@types/react/index.d.ts:771
componentDidCatch
▸ componentDidCatch(error, errorInfo): void
Parameters
| Name | Type |
|---|---|
error | Error |
errorInfo | ErrorInfo |
Returns
void
Overrides
React.Component.componentDidCatch
Defined in
onekijs/packages/onekijs-framework/src/app/AppErrorBoundary.tsx:26
componentDidMount
▸ Optional componentDidMount(): void
Called immediately after a component is mounted. Setting state here will trigger re-rendering.
Returns
void
Inherited from
React.Component.componentDidMount
Defined in
onekijs/node_modules/@types/react/index.d.ts:619
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
| Name | Type |
|---|---|
prevProps | Readonly<AppErrorBoundaryProps> |
prevState | Readonly<AppErrorBoundaryState> |
snapshot? | any |
Returns
void
Inherited from
React.Component.componentDidUpdate
Defined in
onekijs/node_modules/@types/react/index.d.ts:682
componentWillMount
▸ Optional componentWillMount(): void
Called immediately before mounting occurs, and before Component#render.
Avoid introducing any side-effects or subscriptions in this method.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Returns
void
Inherited from
React.Component.componentWillMount
Defined in
onekijs/node_modules/@types/react/index.d.ts:697
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 Component#setState generally does not trigger this method.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters
| Name | Type |
|---|---|
nextProps | Readonly<AppErrorBoundaryProps> |
nextContext | any |
Returns
void
Inherited from
React.Component.componentWillReceiveProps
Defined in
onekijs/node_modules/@types/react/index.d.ts:726
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
React.Component.componentWillUnmount
Defined in
onekijs/node_modules/@types/react/index.d.ts:635
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 Component#setState here.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters
| Name | Type |
|---|---|
nextProps | Readonly<AppErrorBoundaryProps> |
nextState | Readonly<AppErrorBoundaryState> |
nextContext | any |
Returns
void
Inherited from
React.Component.componentWillUpdate
Defined in
onekijs/node_modules/@types/react/index.d.ts:756
forceUpdate
▸ forceUpdate(callback?): void
Parameters
| Name | Type |
|---|---|
callback? | () => void |
Returns
void
Inherited from
React.Component.forceUpdate
Defined in
onekijs/node_modules/@types/react/index.d.ts:490
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 getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.
Parameters
| Name | Type |
|---|---|
prevProps | Readonly<AppErrorBoundaryProps> |
prevState | Readonly<AppErrorBoundaryState> |
Returns
any
Inherited from
React.Component.getSnapshotBeforeUpdate
Defined in
onekijs/node_modules/@types/react/index.d.ts:676
render
▸ render(): ReactNode
Returns
ReactNode
Overrides
React.Component.render
Defined in
onekijs/packages/onekijs-framework/src/app/AppErrorBoundary.tsx:34
setState
▸ setState<K>(state, callback?): void
Type parameters
| Name | Type |
|---|---|
K | extends keyof AppErrorBoundaryState |
Parameters
| Name | Type |
|---|---|
state | null | AppErrorBoundaryState | (prevState: Readonly<AppErrorBoundaryState>, props: Readonly<AppErrorBoundaryProps>) => null | AppErrorBoundaryState | Pick<AppErrorBoundaryState, K> | Pick<AppErrorBoundaryState, K> |
callback? | () => void |
Returns
void
Inherited from
React.Component.setState
Defined in
onekijs/node_modules/@types/react/index.d.ts:485
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, Component#render, componentWillUpdate
and componentDidUpdate will not be called.
Parameters
| Name | Type |
|---|---|
nextProps | Readonly<AppErrorBoundaryProps> |
nextState | Readonly<AppErrorBoundaryState> |
nextContext | any |
Returns
boolean
Inherited from
React.Component.shouldComponentUpdate
Defined in
onekijs/node_modules/@types/react/index.d.ts:630
getDerivedStateFromError
▸ Static getDerivedStateFromError(): Object
Returns
Object
| Name | Type |
|---|---|
hasError | boolean |
Defined in
onekijs/packages/onekijs-framework/src/app/AppErrorBoundary.tsx:22