Skip to content

Commit afe79df

Browse files
authored
updated syntax for registerObserver
1 parent ee31379 commit afe79df

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![Build Status](https://travis-ci.org/nitin42/react-perf-devtool.svg?branch=master)](https://travis-ci.org/nitin42/react-perf-devtool)
44
![Release Status](https://img.shields.io/badge/status-stable-brightgreen.svg)
55
![Author](https://img.shields.io/badge/author-Nitin%20Tulswani-lightgrey.svg)
6+
![current-version](https://img.shields.io/badge/version-3.0.4-blue.svg)
67

78
> A devtool for inspecting the performance of React Components
89
@@ -108,9 +109,8 @@ To use this devtool extension, you'll need to register an observer in your app w
108109
Registering an observer is very simple and is only one function call away. Let's see how!
109110

110111
```js
111-
var registerObserver = require('react-perf-devtool')
112+
const { registerObserver } = require('react-perf-devtool')
112113

113-
// Simple, no?
114114
registerObserver()
115115
```
116116

@@ -135,7 +135,7 @@ You can use this callback to inspect the parsed and aggregated measures, or you
135135
Example -
136136

137137
```js
138-
const registerObserver = require('react-perf-devtool')
138+
const { registerObserver } = require('react-perf-devtool')
139139

140140
function callback(measures) {
141141
// do something with the measures
@@ -185,13 +185,13 @@ You can pass two properties to the **`option`** object, `shouldLog` and `port`.
185185
```js
186186
// index.js file in your React App
187187

188-
var React = require('react')
189-
var ReactDOM = require('react-dom')
190-
var registerObserver = require('react-perf-devtool')
188+
const React = require('react')
189+
const ReactDOM = require('react-dom')
190+
const { registerObserver } = require('react-perf-devtool')
191191

192-
var Component = require('./Component') // Some React Component
192+
const Component = require('./Component') // Some React Component
193193

194-
var options = {
194+
const options = {
195195
shouldLog: true,
196196
port: 8080
197197
}
@@ -207,7 +207,7 @@ ReactDOM.render(<Component />, document.getElementById('root'))
207207

208208
```js
209209
// server.js
210-
var { json } = require('micro')
210+
const { json } = require('micro')
211211

212212
module.exports = async req => {
213213
console.log(await json(req))
@@ -306,7 +306,7 @@ You can also inspect the performance of specific components using options throug
306306
Example -
307307

308308
```js
309-
var options = {
309+
const options = {
310310
shouldLog: true,
311311
port: 3000,
312312
components: ['App', 'Main'] // Assuming you've these components in your project

0 commit comments

Comments
 (0)