Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions packages/core/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,19 +95,28 @@
- [isClassComponent](functions/isClassComponent.md)
- [isComponentDidCatch](functions/isComponentDidCatch.md)
- [isComponentDidMount](functions/isComponentDidMount.md)
- [isComponentDidUpdate](functions/isComponentDidUpdate.md)
- [isComponentName](functions/isComponentName.md)
- [isComponentNameLoose](functions/isComponentNameLoose.md)
- [isComponentWillMount](functions/isComponentWillMount.md)
- [isComponentWillReceiveProps](functions/isComponentWillReceiveProps.md)
- [isComponentWillUnmount](functions/isComponentWillUnmount.md)
- [isComponentWillUpdate](functions/isComponentWillUpdate.md)
- [isComponentWrapperCall](functions/isComponentWrapperCall.md)
- [isComponentWrapperCallLoose](functions/isComponentWrapperCallLoose.md)
- [isDeclaredInRenderPropLoose](functions/isDeclaredInRenderPropLoose.md)
- [isFunctionOfComponentDidMount](functions/isFunctionOfComponentDidMount.md)
- [isFunctionOfComponentWillUnmount](functions/isFunctionOfComponentWillUnmount.md)
- [isFunctionOfRender](functions/isFunctionOfRender.md)
- [isFunctionOfRenderMethod](functions/isFunctionOfRenderMethod.md)
- [isFunctionOfUseEffectCleanup](functions/isFunctionOfUseEffectCleanup.md)
- [isFunctionOfUseEffectSetup](functions/isFunctionOfUseEffectSetup.md)
- [isGetChildContext](functions/isGetChildContext.md)
- [isGetDefaultProps](functions/isGetDefaultProps.md)
- [isGetDerivedStateFromError](functions/isGetDerivedStateFromError.md)
- [isGetDerivedStateFromProps](functions/isGetDerivedStateFromProps.md)
- [isGetInitialState](functions/isGetInitialState.md)
- [isGetSnapshotBeforeUpdate](functions/isGetSnapshotBeforeUpdate.md)
- [isInitializedFromReact](functions/isInitializedFromReact.md)
- [isInsideRenderMethod](functions/isInsideRenderMethod.md)
- [isPureComponent](functions/isPureComponent.md)
Expand All @@ -121,9 +130,14 @@
- [isReactHookName](functions/isReactHookName.md)
- [isReactHookNameLoose](functions/isReactHookNameLoose.md)
- [isRenderFunctionLoose](functions/isRenderFunctionLoose.md)
- [isRenderLike](functions/isRenderLike.md)
- [isRenderMethodLike](functions/isRenderMethodLike.md)
- [isRenderPropLoose](functions/isRenderPropLoose.md)
- [isShouldComponentUpdate](functions/isShouldComponentUpdate.md)
- [isThisSetState](functions/isThisSetState.md)
- [isUnsafeComponentWillMount](functions/isUnsafeComponentWillMount.md)
- [isUnsafeComponentWillReceiveProps](functions/isUnsafeComponentWillReceiveProps.md)
- [isUnsafeComponentWillUpdate](functions/isUnsafeComponentWillUpdate.md)
- [isUseEffectCallLoose](functions/isUseEffectCallLoose.md)
- [isValidComponentDefinition](functions/isValidComponentDefinition.md)
- [useComponentCollector](functions/useComponentCollector.md)
Expand Down
19 changes: 19 additions & 0 deletions packages/core/docs/functions/isComponentDidUpdate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isComponentDidUpdate

# Function: isComponentDidUpdate()

> **isComponentDidUpdate**(`node`): `node is TSESTreeMethodOrProperty`

## Parameters

### node

`Node`

## Returns

`node is TSESTreeMethodOrProperty`
19 changes: 19 additions & 0 deletions packages/core/docs/functions/isComponentWillMount.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isComponentWillMount

# Function: isComponentWillMount()

> **isComponentWillMount**(`node`): `node is TSESTreeMethodOrProperty`

## Parameters

### node

`Node`

## Returns

`node is TSESTreeMethodOrProperty`
19 changes: 19 additions & 0 deletions packages/core/docs/functions/isComponentWillReceiveProps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isComponentWillReceiveProps

# Function: isComponentWillReceiveProps()

> **isComponentWillReceiveProps**(`node`): `node is TSESTreeMethodOrProperty`

## Parameters

### node

`Node`

## Returns

`node is TSESTreeMethodOrProperty`
19 changes: 19 additions & 0 deletions packages/core/docs/functions/isComponentWillUpdate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isComponentWillUpdate

# Function: isComponentWillUpdate()

> **isComponentWillUpdate**(`node`): `node is TSESTreeMethodOrProperty`

## Parameters

### node

`Node`

## Returns

`node is TSESTreeMethodOrProperty`
32 changes: 32 additions & 0 deletions packages/core/docs/functions/isFunctionOfRender.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isFunctionOfRender

# Function: isFunctionOfRender()

> **isFunctionOfRender**(`node`): `boolean`

Check whether given node is a function of a render function of a class component

## Parameters

### node

`TSESTreeFunction`

The AST node to check

## Returns

`boolean`

`true` if node is a render function, `false` if not

## Example

```tsx
class Component extends React.Component {
render = () => <div />;
```
15 changes: 15 additions & 0 deletions packages/core/docs/functions/isFunctionOfRenderMethod.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,27 @@

> **isFunctionOfRenderMethod**(`node`): `boolean`

Check whether given node is a function of a render method of a class component

## Parameters

### node

`TSESTreeFunction`

The AST node to check

## Returns

`boolean`

`true` if node is a render function, `false` if not

## Example

```tsx
class Component extends React.Component {
renderHeader = () => <div />;
renderFooter = () => <div />;
}
```
19 changes: 19 additions & 0 deletions packages/core/docs/functions/isGetChildContext.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isGetChildContext

# Function: isGetChildContext()

> **isGetChildContext**(`node`): `node is TSESTreeMethodOrProperty`

## Parameters

### node

`Node`

## Returns

`node is TSESTreeMethodOrProperty`
19 changes: 19 additions & 0 deletions packages/core/docs/functions/isGetDefaultProps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isGetDefaultProps

# Function: isGetDefaultProps()

> **isGetDefaultProps**(`node`): `node is TSESTreeMethodOrProperty`

## Parameters

### node

`Node`

## Returns

`node is TSESTreeMethodOrProperty`
19 changes: 19 additions & 0 deletions packages/core/docs/functions/isGetInitialState.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isGetInitialState

# Function: isGetInitialState()

> **isGetInitialState**(`node`): `node is TSESTreeMethodOrProperty`

## Parameters

### node

`Node`

## Returns

`node is TSESTreeMethodOrProperty`
19 changes: 19 additions & 0 deletions packages/core/docs/functions/isGetSnapshotBeforeUpdate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isGetSnapshotBeforeUpdate

# Function: isGetSnapshotBeforeUpdate()

> **isGetSnapshotBeforeUpdate**(`node`): `node is TSESTreeMethodOrProperty`

## Parameters

### node

`Node`

## Returns

`node is TSESTreeMethodOrProperty`
35 changes: 35 additions & 0 deletions packages/core/docs/functions/isRenderLike.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isRenderLike

# Function: isRenderLike()

> **isRenderLike**(`node`): `node is TSESTreeMethodOrProperty`

Check whether given node is a render function of a class component

## Parameters

### node

`Node`

The AST node to check

## Returns

`node is TSESTreeMethodOrProperty`

`true` if node is a render function, `false` if not

## Example

```tsx
class Component extends React.Component {
render() {
return <div />;
}
}
```
15 changes: 15 additions & 0 deletions packages/core/docs/functions/isRenderMethodLike.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,27 @@

> **isRenderMethodLike**(`node`): `node is TSESTreeMethodOrProperty`

Check whether given node is a render method of a class component

## Parameters

### node

`Node`

The AST node to check

## Returns

`node is TSESTreeMethodOrProperty`

`true` if node is a render function, `false` if not

## Example

```tsx
class Component extends React.Component {
renderHeader = () => <div />;
renderFooter = () => <div />;
}
```
19 changes: 19 additions & 0 deletions packages/core/docs/functions/isShouldComponentUpdate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isShouldComponentUpdate

# Function: isShouldComponentUpdate()

> **isShouldComponentUpdate**(`node`): `node is TSESTreeMethodOrProperty`

## Parameters

### node

`Node`

## Returns

`node is TSESTreeMethodOrProperty`
19 changes: 19 additions & 0 deletions packages/core/docs/functions/isUnsafeComponentWillMount.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isUnsafeComponentWillMount

# Function: isUnsafeComponentWillMount()

> **isUnsafeComponentWillMount**(`node`): `node is TSESTreeMethodOrProperty`

## Parameters

### node

`Node`

## Returns

`node is TSESTreeMethodOrProperty`
19 changes: 19 additions & 0 deletions packages/core/docs/functions/isUnsafeComponentWillReceiveProps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[**@eslint-react/core**](../README.md)

***

[@eslint-react/core](../README.md) / isUnsafeComponentWillReceiveProps

# Function: isUnsafeComponentWillReceiveProps()

> **isUnsafeComponentWillReceiveProps**(`node`): `node is TSESTreeMethodOrProperty`

## Parameters

### node

`Node`

## Returns

`node is TSESTreeMethodOrProperty`
Loading