Skip to content

Commit

Permalink
added getInformation documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jackHedaya authored Apr 8, 2019
1 parent 7a67400 commit 8484eb0
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ Gets a stock price.
realtime.getPrice("ROKU").then(price => console.log(`ROKU's current price is ${price}.`));
```

#### .getInformation(stock: string)
Gets a stock's information as found on a <a href="https://finance.yahoo.com/quote/ROKU">Yahoo Finance</a> page.
```js

realtime.getInformation("ROKU").then(info => {
console.log(info);
realtime.close();
});
```

#### .close()
Should be ran at the end of your program to close the connection with Yahoo Finance. **If `close` is not called, the program will not exit.**
```js
Expand Down

0 comments on commit 8484eb0

Please sign in to comment.