Add built docs

This commit is contained in:
2019-08-04 00:59:49 +05:30
parent b78906a629
commit 054c50b6f5
11 changed files with 625 additions and 0 deletions
+129
View File
@@ -0,0 +1,129 @@
> **[react-fiber-traverse](../README.md)**
[Globals](../globals.md) / ["utils"](_utils_.md) /
# External module: "utils"
## Index
### Functions
* [isConstructorComponentClass](_utils_.md#isconstructorcomponentclass)
* [isConstructorFunctionComponent](_utils_.md#isconstructorfunctioncomponent)
* [isConstructorHtmlLike](_utils_.md#isconstructorhtmllike)
* [isNodeComponentClass](_utils_.md#isnodecomponentclass)
* [isNodeFunctionComponent](_utils_.md#isnodefunctioncomponent)
* [isNodeHtmlLike](_utils_.md#isnodehtmllike)
* [isNodeNotHtmlLike](_utils_.md#isnodenothtmllike)
## Functions
### isConstructorComponentClass
**isConstructorComponentClass**(`ctr`: `React.ElementType`): *boolean*
*Defined in [utils.ts:40](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L40)*
**Parameters:**
Name | Type |
------ | ------ |
`ctr` | `React.ElementType` |
**Returns:** *boolean*
___
### isConstructorFunctionComponent
**isConstructorFunctionComponent**(`ctr`: `React.ElementType`): *boolean*
*Defined in [utils.ts:57](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L57)*
**Parameters:**
Name | Type |
------ | ------ |
`ctr` | `React.ElementType` |
**Returns:** *boolean*
___
### isConstructorHtmlLike
**isConstructorHtmlLike**(`ctr`: `React.ElementType`): *boolean*
*Defined in [utils.ts:31](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L31)*
**Parameters:**
Name | Type |
------ | ------ |
`ctr` | `React.ElementType` |
**Returns:** *boolean*
___
### isNodeComponentClass
**isNodeComponentClass**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
*Defined in [utils.ts:25](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L25)*
**Parameters:**
Name | Type |
------ | ------ |
`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
**Returns:** *boolean*
___
### isNodeFunctionComponent
**isNodeFunctionComponent**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
*Defined in [utils.ts:19](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L19)*
**Parameters:**
Name | Type |
------ | ------ |
`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
**Returns:** *boolean*
___
### isNodeHtmlLike
**isNodeHtmlLike**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
*Defined in [utils.ts:9](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L9)*
**Parameters:**
Name | Type |
------ | ------ |
`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
**Returns:** *boolean*
___
### isNodeNotHtmlLike
**isNodeNotHtmlLike**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
*Defined in [utils.ts:13](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L13)*
**Parameters:**
Name | Type |
------ | ------ |
`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
**Returns:** *boolean*