Class: Facet<T> | react-ecs

Type parameters

Name	Type
`T`	object

Hierarchy#

Component<NonFunctionProperties<Omit<T, "meta">>>
↳ Facet

Constructors#

constructor#

+ new Facet<T>(props: NonFunctionProperties<Omit<T, "meta">> | Readonly<NonFunctionProperties<Omit<T, "meta">>>): Facet<T>

Type parameters:#

Name	Type
`T`	object

Parameters:#

Name	Type
`props`	NonFunctionProperties<Omit<T, `"meta"`>> \| Readonly<NonFunctionProperties<Omit<T, `"meta"`>>>

Returns: Facet<T>

Inherited from: Component< NonFunctionProperties<Omit<T, 'meta'>> // NonFunctionProperties<Omit<T, ''>>

.constructor

Defined in: node_modules/@types/react/index.d.ts:469

+ new Facet<T>(props: NonFunctionProperties<Omit<T, "meta">>, context: any): Facet<T>

deprecated

see https://reactjs.org/docs/legacy-context.html

Type parameters:#

Name	Type
`T`	object

Parameters:#

Name	Type
`props`	NonFunctionProperties<Omit<T, `"meta"`>>
`context`	any

Returns: Facet<T>

Inherited from: Component< NonFunctionProperties<Omit<T, 'meta'>> // NonFunctionProperties<Omit<T, ''>>

.constructor

Defined in: node_modules/@types/react/index.d.ts:471

Properties#

context#

• context: Entity

Overrides: Component.context

Defined in: libs/core/src/components/Facet.ts:23

props#

• Readonly props: Readonly<NonFunctionProperties<Omit<T, "meta">>> & Readonly<{ children?: ReactNode }>

Inherited from: Component.props

Defined in: node_modules/@types/react/index.d.ts:494

refs#

• refs: object

deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Type declaration:#

Inherited from: Component.refs

Defined in: node_modules/@types/react/index.d.ts:500

state#

• state: Readonly<{}>

Inherited from: Component.state

Defined in: node_modules/@types/react/index.d.ts:495

contextType#

▪ Static contextType: Context<Entity>

Overrides: Component.contextType

Defined in: libs/core/src/components/Facet.ts:22

Methods#

UNSAFE_componentWillMount#

▸ OptionalUNSAFE_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: Component.UNSAFE_componentWillMount

Defined in: node_modules/@types/react/index.d.ts:707

UNSAFE_componentWillReceiveProps#

▸ OptionalUNSAFE_componentWillReceiveProps(nextProps: Readonly<NonFunctionProperties<Omit<T, "meta">>>, nextContext: any): 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<NonFunctionProperties<Omit<T, `"meta"`>>>
`nextContext`	any

Returns: void

Inherited from: Component.UNSAFE_componentWillReceiveProps

Defined in: node_modules/@types/react/index.d.ts:739

UNSAFE_componentWillUpdate#

▸ OptionalUNSAFE_componentWillUpdate(nextProps: Readonly<NonFunctionProperties<Omit<T, "meta">>>, nextState: Readonly<{}>, nextContext: any): 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#reading-dom-properties-before-an-update

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:#

Name	Type
`nextProps`	Readonly<NonFunctionProperties<Omit<T, `"meta"`>>>
`nextState`	Readonly<{}>
`nextContext`	any

Returns: void

Inherited from: Component.UNSAFE_componentWillUpdate

Defined in: node_modules/@types/react/index.d.ts:767

asComponent#

▸ asComponent(): Facet<T>

Returns: Facet<T>

Defined in: libs/core/src/components/Facet.ts:25

componentDidCatch#

▸ OptionalcomponentDidCatch(error: Error, errorInfo: ErrorInfo): void

Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

Parameters:#

Name	Type
`error`	Error
`errorInfo`	ErrorInfo

Returns: void

Inherited from: Component.componentDidCatch

Defined in: node_modules/@types/react/index.d.ts:636

componentDidMount#

▸ componentDidMount(): void

Returns: void

Overrides: Component.componentDidMount

Defined in: libs/core/src/components/Facet.ts:44

componentDidUpdate#

▸ OptionalcomponentDidUpdate(prevProps: Readonly<NonFunctionProperties<Omit<T, "meta">>>, prevState: Readonly<{}>, snapshot?: any): 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<NonFunctionProperties<Omit<T, `"meta"`>>>
`prevState`	Readonly<{}>
`snapshot?`	any

Returns: void

Inherited from: Component.componentDidUpdate

Defined in: node_modules/@types/react/index.d.ts:678

componentWillMount#

▸ OptionalcomponentWillMount(): 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: Component.componentWillMount

Defined in: node_modules/@types/react/index.d.ts:693

componentWillReceiveProps#

▸ OptionalcomponentWillReceiveProps(nextProps: Readonly<NonFunctionProperties<Omit<T, "meta">>>, nextContext: any): 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<NonFunctionProperties<Omit<T, `"meta"`>>>
`nextContext`	any

Returns: void

Inherited from: Component.componentWillReceiveProps

Defined in: node_modules/@types/react/index.d.ts:722

componentWillUnmount#

▸ OptionalcomponentWillUnmount(): 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: Component.componentWillUnmount

Defined in: node_modules/@types/react/index.d.ts:631

componentWillUpdate#

▸ OptionalcomponentWillUpdate(nextProps: Readonly<NonFunctionProperties<Omit<T, "meta">>>, nextState: Readonly<{}>, nextContext: any): 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#reading-dom-properties-before-an-update

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:#

Name	Type
`nextProps`	Readonly<NonFunctionProperties<Omit<T, `"meta"`>>>
`nextState`	Readonly<{}>
`nextContext`	any

Returns: void

Inherited from: Component.componentWillUpdate

Defined in: node_modules/@types/react/index.d.ts:752

createFake#

▸ createFake(): any

Returns: any

Defined in: libs/core/src/components/Facet.ts:29

forceUpdate#

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

Parameters:#

Name	Type
`callback?`	() => void

Returns: void

Inherited from: Component.forceUpdate

Defined in: node_modules/@types/react/index.d.ts:486

getAnnotations#

▸ getAnnotations(fake: unknown): any

Parameters:#

Name	Type
`fake`	unknown

Returns: any

Defined in: libs/core/src/components/Facet.ts:34

getSnapshotBeforeUpdate#

▸ OptionalgetSnapshotBeforeUpdate(prevProps: Readonly<NonFunctionProperties<Omit<T, "meta">>>, prevState: Readonly<{}>): 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<NonFunctionProperties<Omit<T, `"meta"`>>>
`prevState`	Readonly<{}>

Returns: any

Inherited from: Component.getSnapshotBeforeUpdate

Defined in: node_modules/@types/react/index.d.ts:672

render#

▸ render(): any

Returns: any

Overrides: Component.render

Defined in: libs/core/src/components/Facet.ts:56

setState#

▸ setState<K>(state: {} | (prevState: Readonly<{}>, props: Readonly<NonFunctionProperties<Omit<T, "meta">>>) => {} | Pick<{}, K> | Pick<{}, K>, callback?: () => void): void

Type parameters:#

Name	Type
`K`	never

Parameters:#

Name	Type
`state`	{} \| (`prevState`: Readonly<{}>, `props`: Readonly<NonFunctionProperties<Omit<T, `"meta"`>>>) => {} \| Pick<{}, K> \| Pick<{}, K>
`callback?`	() => void

Returns: void

Inherited from: Component.setState

Defined in: node_modules/@types/react/index.d.ts:481

shouldComponentUpdate#

▸ OptionalshouldComponentUpdate(nextProps: Readonly<NonFunctionProperties<Omit<T, "meta">>>, nextState: Readonly<{}>, 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:#

Name	Type
`nextProps`	Readonly<NonFunctionProperties<Omit<T, `"meta"`>>>
`nextState`	Readonly<{}>
`nextContext`	any

Returns: boolean

Inherited from: Component.shouldComponentUpdate

Defined in: node_modules/@types/react/index.d.ts:626