Class GithubLocationAnalyzer

Implements

ScmLocationAnalyzer

Index

Constructors

constructor

Methods

analyze supports

Constructors

constructor

new GithubLocationAnalyzer(
options: GithubLocationAnalyzerOptions,
): GithubLocationAnalyzer
Parameters
- options: GithubLocationAnalyzerOptions
Returns GithubLocationAnalyzer
- Defined in plugins/catalog-backend-module-github/src/analyzers/GithubLocationAnalyzer.ts:50

Methods

analyze

analyze(
    options: AnalyzeOptions,
): Promise<
    {
        existing: {
            entity: Entity;
            isRegistered: boolean;
            location: { target: string; type: string };
        }[];
    },
>
This function can return an array of already existing entities
Parameters
- options: AnalyzeOptions
Returns Promise<
    {
        existing: {
            entity: Entity;
            isRegistered: boolean;
            location: { target: string; type: string };
        }[];
    },
>
Implementation of ScmLocationAnalyzer.analyze
- Defined in plugins/catalog-backend-module-github/src/analyzers/GithubLocationAnalyzer.ts:65

supports

supports(url: string): boolean
The method that decides if this analyzer can work with the provided url
Parameters
- url: string
Returns boolean
Implementation of ScmLocationAnalyzer.supports
- Defined in plugins/catalog-backend-module-github/src/analyzers/GithubLocationAnalyzer.ts:60

Class GithubLocationAnalyzer

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GithubLocationAnalyzer

Methods

analyze

Parameters

Returns Promise<
    {
        existing: {
            entity: Entity;
            isRegistered: boolean;
            location: { target: string; type: string };
        }[];
    },
>

supports

Parameters

Returns boolean

Settings

On This Page

Class GithubLocationAnalyzer

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GithubLocationAnalyzer

Methods

analyze

Parameters

Returns Promise< { existing: { entity: Entity; isRegistered: boolean; location: { target: string; type: string }; }[]; },>

supports

Parameters

Returns boolean

Settings

On This Page

Returns Promise<
{
existing: {
entity: Entity;
isRegistered: boolean;
location: { target: string; type: string };
}[];
},
>