Class: GithubLoader
loaders/github/src.GithubLoader
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
Table of contents
Constructors
Methods
Constructors
constructor
• new GithubLoader()
Methods
canLoad
▸ canLoad(pointer): Promise<boolean>
Parameters
| Name | Type |
|---|---|
pointer | string |
Returns
Promise<boolean>
Defined in
packages/loaders/github/src/index.ts:52
canLoadSync
▸ canLoadSync(pointer): boolean
Parameters
| Name | Type |
|---|---|
pointer | string |
Returns
boolean
Defined in
packages/loaders/github/src/index.ts:56
handleResponse
▸ handleResponse(__namedParameters): Source[] | { document: DocumentNode ; location: undefined | string }[]
Parameters
| Name | Type |
|---|---|
__namedParameters | Object |
__namedParameters.options | any |
__namedParameters.path | string |
__namedParameters.pointer | string |
__namedParameters.response | any |
__namedParameters.status | number |
Returns
Source[] | { document: DocumentNode ; location: undefined | string }[]
Defined in
packages/loaders/github/src/index.ts:87
load
▸ load(pointer, options): Promise<Source[]>
Parameters
| Name | Type |
|---|---|
pointer | string |
options | GithubLoaderOptions |
Returns
Promise<Source[]>
Implementation of
Defined in
packages/loaders/github/src/index.ts:60
loadSync
▸ loadSync(pointer, options): Source[]
Parameters
| Name | Type |
|---|---|
pointer | string |
options | GithubLoaderOptions |
Returns
Source[]
Implementation of
Defined in
packages/loaders/github/src/index.ts:75
prepareRequest
▸ prepareRequest(__namedParameters): RequestInit
Parameters
| Name | Type |
|---|---|
__namedParameters | Object |
__namedParameters.name | string |
__namedParameters.options | GithubLoaderOptions |
__namedParameters.owner | string |
__namedParameters.path | string |
__namedParameters.ref | string |
Returns
RequestInit