Commit c71a980e347ca450e31d2edd03ce812e22a8304e
Document deinit
Charles Lehner committed on 9/20/2016, 1:57:57 AMParent: 7880a84c53be4a312a09ca7cb7d1ac5bafc76d23
Files changed
| README.md | changed |
| README.md | ||
|---|---|---|
| @@ -159,9 +159,18 @@ | ||
| 159 | 159 | - `mention` (object?): mention object, with properties like |
| 160 | 160 | - `mention.open` (boolean?): whether the issue is updated to be open (true), |
| 161 | 161 | closed (false), or not (null) |
| 162 | 162 | |
| 163 | +#### deinit: async | |
| 163 | 164 | |
| 165 | +Deinit the issues object. Closes all live streams. Since `issues` uses live | |
| 166 | +streams, you should call `deinit` when you are done with the issues and want | |
| 167 | +your program to exit or free up resources. | |
| 168 | + | |
| 169 | +```js | |
| 170 | +pulls.deinit(cb) | |
| 171 | +``` | |
| 172 | + | |
| 164 | 173 | ### schemas |
| 165 | 174 | |
| 166 | 175 | ```js |
| 167 | 176 | var issueSchemas = Issues.schemas |
Built with git-ssb-web