Skip to content

Commit

Permalink
chore(docs): add type definition section
Browse files Browse the repository at this point in the history
  • Loading branch information
baruchvlz committed Sep 7, 2019
1 parent ebf380d commit c80b324
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ $ yarn add resq
To get the most out of the library, we recommend you use React Dev Tools to verify the component names you want to select. Granted for basic usage you don't need this as long as you know the component name beforehand, but for Styled components and MaterialUI components it will be of great help.


#### Return object
#### Type definition
```typescript

interface RESQNode {
Expand All @@ -33,6 +33,9 @@ interface RESQNode {
children: RESQNode[]
}

resq$(selector: string, element?: HTMLElement): RESQNode
resq$$(selector: string, element?: HTMLElement): Array<RESQNode>

```

* [Basic Usage](README.md#basic-usage)
Expand Down

0 comments on commit c80b324

Please sign in to comment.