GithubBlog.md

@rena.to/github-blog / GithubBlog

Class: GithubBlog

Table of contents

Constructors

• constructor

Properties

• buildPager
• buildQuery
• client
• getComments
• getLabels
• getPinnedPosts
• getPost
• getPosts
• repo
• sdk

Constructors

constructor

• new GithubBlog(params)

Parameters

Name	Type
params	GithubBlogParams

Defined in

github-blog.ts:26

Properties

buildPager

• buildPager: (args?: PagerParams) => Omit<PagerParams, "offset">

Type declaration

▸ (args?): Omit<PagerParams, "offset">

Parameters

Name	Type
args?	PagerParams

Returns

Omit<PagerParams, "offset">

Defined in

github-blog.ts:24

---

buildQuery

• buildQuery: (args?: GithubQueryParams) => string

Type declaration

▸ (args?): string

Parameters

Name	Type
args?	GithubQueryParams

Returns

string

Defined in

github-blog.ts:23

---

client

• client: GraphQLClient

Defined in

github-blog.ts:20

---

getComments

• getComments: (params: GetCommentsParams) => Promise<Object>

Type declaration

▸ (params): Promise<Object>

Parameters

Name	Type
params	GetCommentsParams

Returns

Promise<Object>

Defined in

github-blog.ts:39

---

getLabels

• getLabels: (params?: GetLabelsParams) => Promise<Object>

Type declaration

▸ (params?): Promise<Object>

Parameters

Name	Type
params?	GetLabelsParams

Returns

Promise<Object>

Defined in

github-blog.ts:40

---

getPinnedPosts

• getPinnedPosts: () => Promise<Object>

Type declaration

▸ (): Promise<Object>

Returns

Promise<Object>

Defined in

github-blog.ts:41

---

getPost

• getPost: (params: GetPostParams) => Promise<{ post: null = null } | { post: Post }>

Type declaration

▸ (params): Promise<{ post: null = null } | { post: Post }>

Parameters

Name	Type
params	GetPostParams

Returns

Promise<{ post: null = null } | { post: Post }>

Defined in

github-blog.ts:38

---

getPosts

• getPosts: (params: GetPostsParams) => Promise<Object>

Type declaration

▸ (params): Promise<Object>

Parameters

Name	Type
params	GetPostsParams

Returns

Promise<Object>

Defined in

github-blog.ts:37

---

repo

• repo: string

Defined in

github-blog.ts:22

---

sdk

• sdk: Object

Type declaration

Name	Type
GetComments	(variables: Exact<Object>, requestHeaders?: HeadersInit) => Promise<GetCommentsQuery>
GetLabels	(variables: Exact<Object>, requestHeaders?: HeadersInit) => Promise<GetLabelsQuery>
GetPinnedPosts	(variables: Exact<Object>, requestHeaders?: HeadersInit) => Promise<GetPinnedPostsQuery>
GetPost	(variables: Exact<Object>, requestHeaders?: HeadersInit) => Promise<GetPostQuery>
GetPosts	(variables: Exact<Object>, requestHeaders?: HeadersInit) => Promise<GetPostsQuery>

Defined in

github-blog.ts:21