Skip to content

Commit

Permalink
improve shallow options doc
Browse files Browse the repository at this point in the history
  • Loading branch information
serut authored and ljharb committed Apr 26, 2017
1 parent df7e225 commit 6c23a8c
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/api/shallow.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,12 @@ describe('<MyComponent />', () => {
1. `node` (`ReactElement`): The node to render
2. `options` (`Object` [optional]):
- `options.context`: (`Object` [optional]): Context to be passed into the component
- `options.disableLifecycleMethods`: (`Boolean` [optional]): If set to true, `componentDidMount`
is not called on the component, and `componentDidUpdate` is not called after
[`setProps`](ShallowWrapper/setProps.md) and [`setContext`](ShallowWrapper/setContext.md).
- `options.lifecycleExperimental`: (`Boolean` [optional]): If set to true, the entire lifecycle (`componentDidMount` and `componentDidUpdate`) of the React component is called. The current default value is `false` with enzyme v2, but the next major version will flip the default value to `true`
- `options.disableLifecycleMethods`: (`Boolean` [optional]): If set to true, most of the React
lifecycle methods will never be executed: `componentDidMount`, `componentWillReceiveProps`,
`shouldComponentUpdate`, `componentWillUpdate` and `componentDidUpdate`. Default to `false`.
- `options.lifecycleExperimental`: (`Boolean` [optional]): If set to true, the entire lifecycle
(`componentDidMount` and `componentDidUpdate`) of the React component is called. The current default value
is `false` with enzyme v2, but the next major version will flip the default value to `true`.

#### Returns

Expand Down

0 comments on commit 6c23a8c

Please sign in to comment.