- Namespace
- Statiq
.Web .GitHub - Interfaces
- Base Types
Syntax
public class ReadGitHub : MultiConfigModule, IModule
Remarks
This modules uses the Octokit library and associated types to submit requests to GitHub. Because of the large number of different kinds of requests, this module does not attempt to provide a fully abstract wrapper around the Octokit library. Instead, it simplifies the housekeeping involved in setting up an Octokit client and requires you to provide functions that fetch whatever data you need.
This module outputs entirely new documents that are representations of the Octokit result object for the request. If the request delegate requires a document, outputs are generated for each input document and concatenated. If the request delegate does not require a document, one set of outputs are generated for the specified request.
Constructors
Name | Summary |
---|---|
ReadGitHub |
Submits a request to the GitHub client. |
ReadGitHub |
|
ReadGitHub |
Submits a request to the GitHub client. |
Properties
Name | Property Type | Summary |
---|---|---|
Configs | IReadOnlyDictionary |
Inherited from Multi
|
Force |
bool |
Inherited from Multi
|