Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Resource<I, SS>

Type parameters

Hierarchy

Implements

Index

Constructors

constructor

Accessors

error

  • get error(): Error | undefined

loaded

  • get loaded(): boolean

loading

  • get loading(): boolean

progress

  • get progress(): number

unloaded

  • get unloaded(): boolean

url

  • get url(): Url

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IProps<I>>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IProps<I>>, nextState: Readonly<IState>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IProps<I>>, prevState: Readonly<IState>, snapshot?: SS): 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

    • prevProps: Readonly<IProps<I>>
    • prevState: Readonly<IState>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

componentWillReceiveProps

  • componentWillReceiveProps(__namedParameters: object): void
  • Parameters

    • __namedParameters: object
      • next: number
      • showLoading: boolean

    Returns void

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IProps<I>>, nextState: Readonly<IState>, nextContext: any): void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IProps<I>>, prevState: Readonly<IState>): SS | null
  • 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

    • prevProps: Readonly<IProps<I>>
    • prevState: Readonly<IState>

    Returns SS | null

reload

  • reload(): Promise<void>

render

  • render(): React.ReactNode

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IProps<I>>, nextState: Readonly<IState>, nextContext: any): 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

    • nextProps: Readonly<IProps<I>>
    • nextState: Readonly<IState>
    • nextContext: any

    Returns boolean

unload

  • unload(): Promise<void>