Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseComponent<Props, State> Abstract

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new BaseComponent<Props, State>(props?: Props, context?: any): BaseComponent<Props, State>

  • Type Parameters

    Parameters

    • Optional props: Props
    • Optional context: any

    Returns BaseComponent<Props, State>

Properties

Optional base

base?: Element | Text

context

context: ViewContext

debug

debug: boolean

propEquality

propEquality: EqualityFuncs<Props>

props

props: RenderableProps<Props, any>

state

state: Readonly<State>

stateEquality

stateEquality: EqualityFuncs<State>

Static addPropsEquality

addPropsEquality: ((this: { prototype: { propEquality: any } }, propEquality: any) => void)

Type declaration

    • (this: { prototype: { propEquality: any } }, propEquality: any): void

    • Parameters

      • this: { prototype: { propEquality: any } }
        • prototype: { propEquality: any }
          • propEquality: any
      • propEquality: any

      Returns void

Static addStateEquality

addStateEquality: ((this: { prototype: { stateEquality: any } }, stateEquality: any) => void)

Type declaration

    • (this: { prototype: { stateEquality: any } }, stateEquality: any): void

    • Parameters

      • this: { prototype: { stateEquality: any } }
        • prototype: { stateEquality: any }
          • stateEquality: any
      • stateEquality: any

      Returns void

Static contextType

contextType: any

Static Optional defaultProps

defaultProps?: any

Static Optional displayName

displayName?: string

Methods

Optional componentDidCatch

  • componentDidCatch(error: any, errorInfo: ErrorInfo): void

  • Parameters

    • error: any
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void

  • Returns void

Optional componentDidUpdate

  • componentDidUpdate(previousProps: Readonly<Props>, previousState: Readonly<State>, snapshot: any): void

  • Parameters

    • previousProps: Readonly<Props>
    • previousState: Readonly<State>
    • snapshot: any

    Returns void

Optional componentWillMount

  • componentWillMount(): void

  • Returns void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<Props>, nextContext: any): void

  • Parameters

    • nextProps: Readonly<Props>
    • nextContext: any

    Returns void

Optional componentWillUnmount

  • componentWillUnmount(): void

  • Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<Props>, nextState: Readonly<State>, nextContext: any): void

  • Parameters

    • nextProps: Readonly<Props>
    • nextState: Readonly<State>
    • nextContext: any

    Returns void

forceUpdate

  • forceUpdate(callback?: (() => void)): void

  • Parameters

    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns void

Optional getChildContext

  • getChildContext(): object

  • Returns object

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(oldProps: Readonly<Props>, oldState: Readonly<State>): any

  • Parameters

    • oldProps: Readonly<Props>
    • oldState: Readonly<State>

    Returns any

Abstract render

  • render(props?: RenderableProps<Props, any>, state?: Readonly<State>, context?: any): ComponentChild

  • Parameters

    • Optional props: RenderableProps<Props, any>
    • Optional state: Readonly<State>
    • Optional context: any

    Returns ComponentChild

safeSetState

  • safeSetState(newState: Partial<State>): void

  • Parameters

    • newState: Partial<State>

    Returns void

setState

  • setState<K>(state: null | Partial<State> | ((prevState: Readonly<State>, props: Readonly<Props>) => null | Partial<State> | Pick<State, K>) | Pick<State, K>, callback?: (() => void)): void

  • Type Parameters

    • K extends string | number | symbol

    Parameters

    • state: null | Partial<State> | ((prevState: Readonly<State>, props: Readonly<Props>) => null | Partial<State> | Pick<State, K>) | Pick<State, K>
    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns void

shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Props, nextState: State): boolean

  • Parameters

    • nextProps: Props
    • nextState: State

    Returns boolean

Static Optional getDerivedStateFromError

  • getDerivedStateFromError(error: any): null | object

  • Parameters

    • error: any

    Returns null | object

Static Optional getDerivedStateFromProps

  • getDerivedStateFromProps(props: object, state: object): null | object

  • Parameters

    • props: object
    • state: object

    Returns null | object

Generated using TypeDoc