|
| 1 | +@rena.to/github-blog |
| 2 | + |
| 3 | +#@rena.to/github-blog |
| 4 | + |
| 5 | +##Table of contents |
| 6 | + |
| 7 | +###Enumerations |
| 8 | + |
| 9 | +-[Reaction](enums/Reaction.md) |
| 10 | + |
| 11 | +###Classes |
| 12 | + |
| 13 | +-[GithubBlog](classes/GithubBlog.md) |
| 14 | + |
| 15 | +###Type aliases |
| 16 | + |
| 17 | +-[Author](README.md#author) |
| 18 | +-[Comment](README.md#comment) |
| 19 | +-[GetComments](README.md#getcomments) |
| 20 | +-[GetCommentsParams](README.md#getcommentsparams) |
| 21 | +-[GetCommentsResult](README.md#getcommentsresult) |
| 22 | +-[GetLabels](README.md#getlabels) |
| 23 | +-[GetLabelsParams](README.md#getlabelsparams) |
| 24 | +-[GetLabelsResult](README.md#getlabelsresult) |
| 25 | +-[GetPinnedPosts](README.md#getpinnedposts) |
| 26 | +-[GetPinnedPostsParams](README.md#getpinnedpostsparams) |
| 27 | +-[GetPinnedPostsResult](README.md#getpinnedpostsresult) |
| 28 | +-[GetPost](README.md#getpost) |
| 29 | +-[GetPostParams](README.md#getpostparams) |
| 30 | +-[GetPostResult](README.md#getpostresult) |
| 31 | +-[GetPosts](README.md#getposts) |
| 32 | +-[GetPostsParams](README.md#getpostsparams) |
| 33 | +-[GetPostsResult](README.md#getpostsresult) |
| 34 | +-[GithubBlogParams](README.md#githubblogparams) |
| 35 | +-[GithubQueryParams](README.md#githubqueryparams) |
| 36 | +-[Label](README.md#label) |
| 37 | +-[Labels](README.md#labels) |
| 38 | +-[PagerParams](README.md#pagerparams) |
| 39 | +-[Post](README.md#post) |
| 40 | +-[PostReduced](README.md#postreduced) |
| 41 | +-[Reactions](README.md#reactions) |
| 42 | + |
| 43 | +##Type aliases |
| 44 | + |
| 45 | +###Author |
| 46 | + |
| 47 | +Ƭ**Author**: typeof`Author.Type` |
| 48 | + |
| 49 | +####Defined in |
| 50 | + |
| 51 | +[public-types.ts:4](https://github.com/renatorib/github-blog/blob/694d2f5/src/public-types.ts#L4) |
| 52 | + |
| 53 | +--- |
| 54 | + |
| 55 | +###Comment |
| 56 | + |
| 57 | +Ƭ**Comment**: typeof`Comment.Type` |
| 58 | + |
| 59 | +####Defined in |
| 60 | + |
| 61 | +[public-types.ts:7](https://github.com/renatorib/github-blog/blob/694d2f5/src/public-types.ts#L7) |
| 62 | + |
| 63 | +--- |
| 64 | + |
| 65 | +###GetComments |
| 66 | + |
| 67 | +Ƭ**GetComments**:`ReturnType`<typeof`getComments`\> |
| 68 | + |
| 69 | +####Defined in |
| 70 | + |
| 71 | +[methods/getComments.ts:74](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getComments.ts#L74) |
| 72 | + |
| 73 | +--- |
| 74 | + |
| 75 | +###GetCommentsParams |
| 76 | + |
| 77 | +Ƭ**GetCommentsParams**:`Object` |
| 78 | + |
| 79 | +####Type declaration |
| 80 | + |
| 81 | +| Name| Type| Description| |
| 82 | +| :-------| :-----------------------------------------------------------------------| :-----------------------------------------------------------------------------| |
| 83 | +|`pager?`|`Omit`<[`PagerParams`](README.md#pagerparams),`"limit"`\|`"offset"`\>| Pagination with limit and offset don't work in comments. Use cursor pagination| |
| 84 | +|`query?`|[`GithubQueryParams`](README.md#githubqueryparams)| -| |
| 85 | + |
| 86 | +####Defined in |
| 87 | + |
| 88 | +[methods/getComments.ts:33](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getComments.ts#L33) |
| 89 | + |
| 90 | +--- |
| 91 | + |
| 92 | +###GetCommentsResult |
| 93 | + |
| 94 | +Ƭ**GetCommentsResult**:`Unwrap`<`ReturnType`<[`GetComments`](README.md#getcomments)\>\> |
| 95 | + |
| 96 | +####Defined in |
| 97 | + |
| 98 | +[methods/getComments.ts:76](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getComments.ts#L76) |
| 99 | + |
| 100 | +--- |
| 101 | + |
| 102 | +###GetLabels |
| 103 | + |
| 104 | +Ƭ**GetLabels**:`ReturnType`<typeof`getLabels`\> |
| 105 | + |
| 106 | +####Defined in |
| 107 | + |
| 108 | +[methods/getLabels.ts:71](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getLabels.ts#L71) |
| 109 | + |
| 110 | +--- |
| 111 | + |
| 112 | +###GetLabelsParams |
| 113 | + |
| 114 | +Ƭ**GetLabelsParams**:`Object` |
| 115 | + |
| 116 | +####Type declaration |
| 117 | + |
| 118 | +| Name| Type| |
| 119 | +| :-------| :-------------------------------------| |
| 120 | +|`pager?`|[`PagerParams`](README.md#pagerparams)| |
| 121 | +|`query?`|`string`| |
| 122 | + |
| 123 | +####Defined in |
| 124 | + |
| 125 | +[methods/getLabels.ts:36](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getLabels.ts#L36) |
| 126 | + |
| 127 | +--- |
| 128 | + |
| 129 | +###GetLabelsResult |
| 130 | + |
| 131 | +Ƭ**GetLabelsResult**:`Unwrap`<`ReturnType`<[`GetLabels`](README.md#getlabels)\>\> |
| 132 | + |
| 133 | +####Defined in |
| 134 | + |
| 135 | +[methods/getLabels.ts:73](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getLabels.ts#L73) |
| 136 | + |
| 137 | +--- |
| 138 | + |
| 139 | +###GetPinnedPosts |
| 140 | + |
| 141 | +Ƭ**GetPinnedPosts**:`ReturnType`<typeof`getPinnedPosts`\> |
| 142 | + |
| 143 | +####Defined in |
| 144 | + |
| 145 | +[methods/getPinnedPosts.ts:41](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getPinnedPosts.ts#L41) |
| 146 | + |
| 147 | +--- |
| 148 | + |
| 149 | +###GetPinnedPostsParams |
| 150 | + |
| 151 | +Ƭ**GetPinnedPostsParams**:`never` |
| 152 | + |
| 153 | +####Defined in |
| 154 | + |
| 155 | +[methods/getPinnedPosts.ts:25](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getPinnedPosts.ts#L25) |
| 156 | + |
| 157 | +--- |
| 158 | + |
| 159 | +###GetPinnedPostsResult |
| 160 | + |
| 161 | +Ƭ**GetPinnedPostsResult**:`Unwrap`<`ReturnType`<[`GetPinnedPosts`](README.md#getpinnedposts)\>\> |
| 162 | + |
| 163 | +####Defined in |
| 164 | + |
| 165 | +[methods/getPinnedPosts.ts:43](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getPinnedPosts.ts#L43) |
| 166 | + |
| 167 | +--- |
| 168 | + |
| 169 | +###GetPost |
| 170 | + |
| 171 | +Ƭ**GetPost**:`ReturnType`<typeof`getPost`\> |
| 172 | + |
| 173 | +####Defined in |
| 174 | + |
| 175 | +[methods/getPost.ts:39](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getPost.ts#L39) |
| 176 | + |
| 177 | +--- |
| 178 | + |
| 179 | +###GetPostParams |
| 180 | + |
| 181 | +Ƭ**GetPostParams**:`Object` |
| 182 | + |
| 183 | +####Type declaration |
| 184 | + |
| 185 | +| Name| Type| |
| 186 | +| :-------| :-------------------------------------------------| |
| 187 | +|`query?`|[`GithubQueryParams`](README.md#githubqueryparams)| |
| 188 | + |
| 189 | +####Defined in |
| 190 | + |
| 191 | +[methods/getPost.ts:19](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getPost.ts#L19) |
| 192 | + |
| 193 | +--- |
| 194 | + |
| 195 | +###GetPostResult |
| 196 | + |
| 197 | +Ƭ**GetPostResult**:`Unwrap`<`ReturnType`<[`GetPost`](README.md#getpost)\>\> |
| 198 | + |
| 199 | +####Defined in |
| 200 | + |
| 201 | +[methods/getPost.ts:41](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getPost.ts#L41) |
| 202 | + |
| 203 | +--- |
| 204 | + |
| 205 | +###GetPosts |
| 206 | + |
| 207 | +Ƭ**GetPosts**:`ReturnType`<typeof`getPosts`\> |
| 208 | + |
| 209 | +####Defined in |
| 210 | + |
| 211 | +[methods/getPosts.ts:66](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getPosts.ts#L66) |
| 212 | + |
| 213 | +--- |
| 214 | + |
| 215 | +###GetPostsParams |
| 216 | + |
| 217 | +Ƭ**GetPostsParams**:`Object` |
| 218 | + |
| 219 | +####Type declaration |
| 220 | + |
| 221 | +| Name| Type| |
| 222 | +| :-------| :-------------------------------------------------| |
| 223 | +|`pager?`|[`PagerParams`](README.md#pagerparams)| |
| 224 | +|`query?`|[`GithubQueryParams`](README.md#githubqueryparams)| |
| 225 | + |
| 226 | +####Defined in |
| 227 | + |
| 228 | +[methods/getPosts.ts:29](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getPosts.ts#L29) |
| 229 | + |
| 230 | +--- |
| 231 | + |
| 232 | +###GetPostsResult |
| 233 | + |
| 234 | +Ƭ**GetPostsResult**:`Unwrap`<`ReturnType`<[`GetPosts`](README.md#getposts)\>\> |
| 235 | + |
| 236 | +####Defined in |
| 237 | + |
| 238 | +[methods/getPosts.ts:68](https://github.com/renatorib/github-blog/blob/694d2f5/src/methods/getPosts.ts#L68) |
| 239 | + |
| 240 | +--- |
| 241 | + |
| 242 | +###GithubBlogParams |
| 243 | + |
| 244 | +Ƭ**GithubBlogParams**:`Object` |
| 245 | + |
| 246 | +####Type declaration |
| 247 | + |
| 248 | +| Name| Type| |
| 249 | +| :--------------------| :-------------------------------------------------------------| |
| 250 | +|`paginationDefaults?`|`Partial`<[`PagerParams`](README.md#pagerparams)\>| |
| 251 | +|`queryDefaults?`|`Partial`<[`GithubQueryParams`](README.md#githubqueryparams)\>| |
| 252 | +|`repo`|`string`| |
| 253 | +|`token`|`string`| |
| 254 | + |
| 255 | +####Defined in |
| 256 | + |
| 257 | +[github-blog.ts:13](https://github.com/renatorib/github-blog/blob/694d2f5/src/github-blog.ts#L13) |
| 258 | + |
| 259 | +--- |
| 260 | + |
| 261 | +###GithubQueryParams |
| 262 | + |
| 263 | +Ƭ**GithubQueryParams**:`Object` |
| 264 | + |
| 265 | +####Type declaration |
| 266 | + |
| 267 | +| Name| Type| |
| 268 | +| :-----------| :---------------------| |
| 269 | +|`author?`|`string`\|`string`[]| |
| 270 | +|`flag?`|`string`\|`string`[]| |
| 271 | +|`notAuthor?`|`string`\|`string`[]| |
| 272 | +|`notFlag?`|`string`\|`string`[]| |
| 273 | +|`notState?`|`string`\|`string`[]| |
| 274 | +|`notTag?`|`string`\|`string`[]| |
| 275 | +|`notType?`|`string`\|`string`[]| |
| 276 | +|`overrides?`|`string`| |
| 277 | +|`search?`|`string`| |
| 278 | +|`slug?`|`string`| |
| 279 | +|`sort?`|`Sort`| |
| 280 | +|`state?`|`string`\|`string`[]| |
| 281 | +|`tag?`|`string`\|`string`[]| |
| 282 | +|`type?`|`string`\|`string`[]| |
| 283 | + |
| 284 | +####Defined in |
| 285 | + |
| 286 | +[utils/github-query.ts:12](https://github.com/renatorib/github-blog/blob/694d2f5/src/utils/github-query.ts#L12) |
| 287 | + |
| 288 | +--- |
| 289 | + |
| 290 | +###Label |
| 291 | + |
| 292 | +Ƭ**Label**: typeof`Label.Type` |
| 293 | + |
| 294 | +####Defined in |
| 295 | + |
| 296 | +[public-types.ts:10](https://github.com/renatorib/github-blog/blob/694d2f5/src/public-types.ts#L10) |
| 297 | + |
| 298 | +--- |
| 299 | + |
| 300 | +###Labels |
| 301 | + |
| 302 | +Ƭ**Labels**: typeof`Labels.Type` |
| 303 | + |
| 304 | +####Defined in |
| 305 | + |
| 306 | +[public-types.ts:13](https://github.com/renatorib/github-blog/blob/694d2f5/src/public-types.ts#L13) |
| 307 | + |
| 308 | +--- |
| 309 | + |
| 310 | +###PagerParams |
| 311 | + |
| 312 | +Ƭ**PagerParams**:`Object` |
| 313 | + |
| 314 | +####Type declaration |
| 315 | + |
| 316 | +| Name| Type| |
| 317 | +| :--------| :-------| |
| 318 | +|`after?`|`string`| |
| 319 | +|`before?`|`string`| |
| 320 | +|`first?`|`number`| |
| 321 | +|`last?`|`number`| |
| 322 | +|`limit?`|`number`| |
| 323 | +|`offset?`|`number`| |
| 324 | + |
| 325 | +####Defined in |
| 326 | + |
| 327 | +[utils/pager.ts:1](https://github.com/renatorib/github-blog/blob/694d2f5/src/utils/pager.ts#L1) |
| 328 | + |
| 329 | +--- |
| 330 | + |
| 331 | +###Post |
| 332 | + |
| 333 | +Ƭ**Post**: typeof`Post.Type` |
| 334 | + |
| 335 | +####Defined in |
| 336 | + |
| 337 | +[public-types.ts:16](https://github.com/renatorib/github-blog/blob/694d2f5/src/public-types.ts#L16) |
| 338 | + |
| 339 | +--- |
| 340 | + |
| 341 | +###PostReduced |
| 342 | + |
| 343 | +Ƭ**PostReduced**: typeof`PostReduced.Type` |
| 344 | + |
| 345 | +####Defined in |
| 346 | + |
| 347 | +[public-types.ts:19](https://github.com/renatorib/github-blog/blob/694d2f5/src/public-types.ts#L19) |
| 348 | + |
| 349 | +--- |
| 350 | + |
| 351 | +###Reactions |
| 352 | + |
| 353 | +Ƭ**Reactions**: typeof`Reactions.Type` |
| 354 | + |
| 355 | +####Defined in |
| 356 | + |
| 357 | +[public-types.ts:22](https://github.com/renatorib/github-blog/blob/694d2f5/src/public-types.ts#L22) |