docs

@rena.to/github-blog

@rena.to/github-blog

Table of contents

Enumerations

• Reaction

Classes

• GithubBlog

Type aliases

• Author
• Comment
• GetComments
• GetCommentsParams
• GetCommentsResult
• GetLabels
• GetLabelsParams
• GetLabelsResult
• GetPinnedPosts
• GetPinnedPostsParams
• GetPinnedPostsResult
• GetPost
• GetPostParams
• GetPostResult
• GetPosts
• GetPostsParams
• GetPostsResult
• GithubBlogParams
• GithubQueryParams
• Label
• Labels
• PagerParams
• Post
• PostReduced
• Reactions

Type aliases

Author

Ƭ Author: typeof Author.Type

Defined in

public-types.ts:4

---

Comment

Ƭ Comment: typeof Comment.Type

Defined in

public-types.ts:7

---

GetComments

Ƭ GetComments: ReturnType<typeof getComments>

Defined in

methods/getComments.ts:74

---

GetCommentsParams

Ƭ GetCommentsParams: Object

Type declaration

Name	Type	Description
pager?	Omit<PagerParams, "limit" | "offset">	Pagination with limit and offset don't work in comments. Use cursor pagination
query?	GithubQueryParams	-

Defined in

methods/getComments.ts:33

---

GetCommentsResult

Ƭ GetCommentsResult: Unwrap<ReturnType<GetComments>>

Defined in

methods/getComments.ts:76

---

GetLabels

Ƭ GetLabels: ReturnType<typeof getLabels>

Defined in

methods/getLabels.ts:71

---

GetLabelsParams

Ƭ GetLabelsParams: Object

Type declaration

Name	Type
pager?	PagerParams
query?	string

Defined in

methods/getLabels.ts:36

---

GetLabelsResult

Ƭ GetLabelsResult: Unwrap<ReturnType<GetLabels>>

Defined in

methods/getLabels.ts:73

---

GetPinnedPosts

Ƭ GetPinnedPosts: ReturnType<typeof getPinnedPosts>

Defined in

methods/getPinnedPosts.ts:41

---

GetPinnedPostsParams

Ƭ GetPinnedPostsParams: never

Defined in

methods/getPinnedPosts.ts:25

---

GetPinnedPostsResult

Ƭ GetPinnedPostsResult: Unwrap<ReturnType<GetPinnedPosts>>

Defined in

methods/getPinnedPosts.ts:43

---

GetPost

Ƭ GetPost: ReturnType<typeof getPost>

Defined in

methods/getPost.ts:39

---

GetPostParams

Ƭ GetPostParams: Object

Type declaration

Name	Type
query?	GithubQueryParams

Defined in

methods/getPost.ts:19

---

GetPostResult

Ƭ GetPostResult: Unwrap<ReturnType<GetPost>>

Defined in

methods/getPost.ts:41

---

GetPosts

Ƭ GetPosts: ReturnType<typeof getPosts>

Defined in

methods/getPosts.ts:66

---

GetPostsParams

Ƭ GetPostsParams: Object

Type declaration

Name	Type
pager?	PagerParams
query?	GithubQueryParams

Defined in

methods/getPosts.ts:29

---

GetPostsResult

Ƭ GetPostsResult: Unwrap<ReturnType<GetPosts>>

Defined in

methods/getPosts.ts:68

---

GithubBlogParams

Ƭ GithubBlogParams: Object

Type declaration

Name	Type
paginationDefaults?	Partial<PagerParams>
queryDefaults?	Partial<GithubQueryParams>
repo	string
token	string

Defined in

github-blog.ts:13

---

GithubQueryParams

Ƭ GithubQueryParams: Object

Type declaration

Name	Type
author?	string | string[]
flag?	string | string[]
notAuthor?	string | string[]
notFlag?	string | string[]
notState?	string | string[]
notTag?	string | string[]
notType?	string | string[]
overrides?	string
search?	string
slug?	string
sort?	Sort
state?	string | string[]
tag?	string | string[]
type?	string | string[]

Defined in

utils/github-query.ts:12

---

Label

Ƭ Label: typeof Label.Type

Defined in

public-types.ts:10

---

Labels

Ƭ Labels: typeof Labels.Type

Defined in

public-types.ts:13

---

PagerParams

Ƭ PagerParams: Object

Type declaration

Name	Type
after?	string
before?	string
first?	number
last?	number
limit?	number
offset?	number

Defined in

utils/pager.ts:1

---

Post

Ƭ Post: typeof Post.Type

Defined in

public-types.ts:16

---

PostReduced

Ƭ PostReduced: typeof PostReduced.Type

Defined in

public-types.ts:19

---

Reactions

Ƭ Reactions: typeof Reactions.Type

Defined in

public-types.ts:22