Class: GithubLoader
Defined in: packages/loaders/github/src/index.ts:69
This loader loads a file from GitHub.
const typeDefs = await loadTypedefs('github:githubUser/githubRepo#branchName:path/to/file.ts', {
loaders: [new GithubLoader()],
token: YOUR_GITHUB_TOKEN,
})Implements
Constructors
Constructor
new GithubLoader():
GithubLoader
Returns
GithubLoader
Methods
canLoad()
canLoad(
pointer):Promise<boolean>
Defined in: packages/loaders/github/src/index.ts:70
Parameters
pointer
string
Returns
Promise<boolean>
canLoadSync()
canLoadSync(
pointer):boolean
Defined in: packages/loaders/github/src/index.ts:74
Parameters
pointer
string
Returns
boolean
handleResponse()
handleResponse(
__namedParameters):Source[] |object[]
Defined in: packages/loaders/github/src/index.ts:133
Parameters
__namedParameters
options
any
path
string
pointer
string
response
any
status
number
Returns
Source[] | object[]
load()
load(
pointer,options):Promise<Source[]>
Defined in: packages/loaders/github/src/index.ts:123
Parameters
pointer
string
options
Returns
Promise<Source[]>
Implementation of
loadSync()
loadSync(
pointer,options):Source[]
Defined in: packages/loaders/github/src/index.ts:128
Parameters
pointer
string
options
Returns
Source[]
Implementation of
loadSyncOrAsync()
Call Signature
loadSyncOrAsync(
pointer,options,asyncFetchFn):Promise<Source[]>
Defined in: packages/loaders/github/src/index.ts:78
Parameters
pointer
string
options
asyncFetchFn
AsyncFetchFn
Returns
Promise<Source[]>
Call Signature
loadSyncOrAsync(
pointer,options,syncFetchFn):Source[]
Defined in: packages/loaders/github/src/index.ts:84
Parameters
pointer
string
options
syncFetchFn
SyncFetchFn
Returns
Source[]
prepareRequest()
prepareRequest(
__namedParameters):RequestInit
Defined in: packages/loaders/github/src/index.ts:192
Parameters
__namedParameters
name
string
options
owner
string
path
string
ref
string
Returns
RequestInit