bendtherules/react-fiber-traverse
1
0
Fork 0
mirror of https://github.com/bendtherules/react-fiber-traverse.git synced 2026-08-18 22:01:49 +00:00
Code Issues 25 Packages Projects Releases Wiki Activity

Add built docs

Browse Source
This commit is contained in:
bendtherules
2019-08-04 00:59:49 +05:30
parent b78906a629
commit 054c50b6f5
11 changed files with 625 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/modules/_findnode_.md
+64
View File
@@ -0,0 +1,64 @@
> **[react-fiber-traverse](../README.md)**
[Globals](../globals.md) / ["findNode"](_findnode_.md) /
# External module: "findNode"
## Index
### Functions
* [findNodeByComponent](_findnode_.md#findnodebycomponent)
* [findNodeByComponentName](_findnode_.md#findnodebycomponentname)
* [findNodeByComponentRef](_findnode_.md#findnodebycomponentref)
## Functions
### findNodeByComponent
▸ **findNodeByComponent**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedClassOrFunction`: `React.ComponentType`): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
*Defined in [findNode.ts:32](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/findNode.ts#L32)*
**Parameters:**
Name | Type |
------ | ------ |
`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
`expectedClassOrFunction` | `React.ComponentType` |
**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null*
___
### findNodeByComponentName
▸ **findNodeByComponentName**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedName`: string): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
*Defined in [findNode.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/findNode.ts#L4)*
**Parameters:**
Name | Type |
------ | ------ |
`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
`expectedName` | string |
**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null*
___
### findNodeByComponentRef
▸ **findNodeByComponentRef**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedClassInstance`: `Component`): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
*Defined in [findNode.ts:63](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/findNode.ts#L63)*
**Parameters:**
Name | Type |
------ | ------ |
`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
`expectedClassInstance` | `Component` |
**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null*
docs/modules/_index_.md
+5
View File
@@ -0,0 +1,5 @@
> **[react-fiber-traverse](../README.md)**
[Globals](../globals.md) / ["index"](_index_.md) /
# External module: "index"
docs/modules/_mocked_types_index_.md
+35
View File
@@ -0,0 +1,35 @@
> **[react-fiber-traverse](../README.md)**
[Globals](../globals.md) / ["mocked-types/index"](_mocked_types_index_.md) /
# External module: "mocked-types/index"
## Index
### Interfaces
* [FiberNodeForComponentClass](../interfaces/_mocked_types_index_.fibernodeforcomponentclass.md)
* [FiberNodeForFunctionComponent](../interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md)
* [FiberNodeForInstrinsicElement](../interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md)
* [FiberNodeForTextNode](../interfaces/_mocked_types_index_.fibernodefortextnode.md)
### Type aliases
* [FiberNode](_mocked_types_index_.md#fibernode)
* [FiberNodeisHTMLLike](_mocked_types_index_.md#fibernodeishtmllike)
## Type aliases
### FiberNode
Ƭ **FiberNode**: *[FiberNodeForComponentClass](../interfaces/_mocked_types_index_.fibernodeforcomponentclass.md) | [FiberNodeForFunctionComponent](../interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md) | [FiberNodeForInstrinsicElement](../interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md) | [FiberNodeForTextNode](../interfaces/_mocked_types_index_.fibernodefortextnode.md)*
*Defined in [mocked-types/index.ts:3](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L3)*
___
### FiberNodeisHTMLLike
Ƭ **FiberNodeisHTMLLike**: *[FiberNodeForInstrinsicElement](../interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md) | [FiberNodeForTextNode](../interfaces/_mocked_types_index_.fibernodefortextnode.md)*
*Defined in [mocked-types/index.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L59)*
docs/modules/_traverse_.md
+56
View File
@@ -0,0 +1,56 @@
> **[react-fiber-traverse](../README.md)**
[Globals](../globals.md) / ["traverse"](_traverse_.md) /
# External module: "traverse"
## Index
### Functions
* [traverse](_traverse_.md#traverse)
* [traverseGenerator](_traverse_.md#traversegenerator)
## Functions
### traverse
▸ **traverse**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `fn`: function): *void*
*Defined in [traverse.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/traverse.ts#L4)*
**Parameters:**
▪ **node**: *[FiberNode](_mocked_types_index_.md#fibernode)*
▪ **fn**: *function*
▸ (`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *any*
**Parameters:**
Name | Type |
------ | ------ |
`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
**Returns:** *void*
___
### traverseGenerator
▸ **traverseGenerator**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `__namedParameters`: object): *`IterableIterator<FiberNode>`*
*Defined in [traverse.ts:15](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/traverse.ts#L15)*
**Parameters:**
▪ **node**: *[FiberNode](_mocked_types_index_.md#fibernode)*
▪`Default value` **__namedParameters**: *object*= {}
Name | Type | Default |
------ | ------ | ------ |
`order` | "self" \| "child" \| "sibling"[] | ["self", "child", "sibling"] |
**Returns:** *`IterableIterator<FiberNode>`*
docs/modules/_utils_.md
+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*