Skip to main content

GithubUrlReader

Home > @backstage/backend-common > GithubUrlReader

Implements a UrlReaderService for files through the GitHub v3 APIs, such as the one exposed by GitHub itself.

Signature:

class GithubUrlReader implements UrlReader 

Implements: UrlReader

Constructors

ConstructorModifiersDescription
(constructor)(integration, deps)Constructs a new instance of the GithubUrlReader class

Properties

PropertyModifiersTypeDescription
factorystaticReaderFactory

Methods

MethodModifiersDescription
read(url)
readTree(url, options)
readUrl(url, options)
search(url, options)
toString()