Class APIFetcher

Primary fetcher for GitHub API

Hierarchy

APIFetcher

Index

Constructors

constructor

Properties

Accessors

apiAccessToken

Methods

Constructors

constructor

new APIFetcher(apiAccessToken?: undefined | string): APIFetcher

- Defined in fetcher/api-fetcher.ts:33
Parameters
- Optional apiAccessToken: undefined | string
  
  GitHub API access token
Returns APIFetcher

Properties

gist

gist: GistRoute

Gist route

organization

organization: OrganizationRoute

Organization route

repository

repository: RepositoryRoute

Repository route

user

user: UserRoute

User route

Accessors

apiAccessToken

get apiAccessToken(): string
set apiAccessToken(apiAccessToken: string): void

- Defined in fetcher/api-fetcher.ts:57
Set GitHub API access token for client

Returns string

GitHub API access token for client
- Defined in fetcher/api-fetcher.ts:66
Set GitHub API access token for client

Parameters
- apiAccessToken: string
  
  GitHub API access token
Returns void

GitHub API access token for client

Methods

fetch

fetch<T>(request: GraphQLRequest<T>): Promise<T | null>

- Defined in fetcher/api-fetcher.ts:79
Fetches data from GitHub API according to the request taken as argument. Null is returned if a specific resource (e.g. user/organization/repository) was not found.

throws

RequestError

Type parameters
- T
  
  Response data type
Parameters
- request: GraphQLRequest<T>
  
  GraphQL request
Returns Promise<T | null>

pageFetch

pageFetch<T>(pagedRequest: GraphQLPagedRequest<T>): Promise<T[] | null>

- Defined in fetcher/api-fetcher.ts:107
Fetches the total data of several possible pages from GitHub API according to the request taken as argument. Null is returned if a specific resource (e.g. user/organization/repository) was not found.

throws

RequestError

Type parameters
- T
  
  Response data type
Parameters
- pagedRequest: GraphQLPagedRequest<T>
  
  Paged GraphQL request that includes page info
Returns Promise<T[] | null>

Generated using TypeDoc