Function

Static Public Summary
public	cloneRepo(repoPath: string, cloneDir: string): Promise Clone Repository
public	get(name: string): string \| undefined Get environment variables
public	getDiff(repo: Object, opts: String[]): Promise Get Diff Strings
public	getDiffPages(repo: Object, pages: Object[]): Promise Get Diff Strings for Pages
public	getRepo(repoPath: string, cloneDir: string): Promise Get Repository
public	getRepoNameFromRemotePath(repoPath: string): string Get Repository name from remote path
public	getRepoPathFromPayload(payload: Object): string Get remote repository path from payload object

Static Public

import {cloneRepo} from 'github-wiki-notifier/src/repository.js'

Clone Repository

import {get} from 'github-wiki-notifier/src/utils/env.js'

Get environment variables

Name	Type	Attribute	Description
name	string		variable name

import {getDiff} from 'github-wiki-notifier/src/repository.js'

Get Diff Strings

Name	Type	Attribute	Description
repo	Object		repository object of simple-git
opts	String[]		diff options for Git command

import {getDiffPages} from 'github-wiki-notifier/src/repository.js'

Get Diff Strings for Pages

Name	Type	Attribute	Description
repo	Object		repository object of simple-git
pages	Object[]		pages

import {getRepo} from 'github-wiki-notifier/src/repository.js'

Get Repository

import {getRepoNameFromRemotePath} from 'github-wiki-notifier/src/repository.js'

Get Repository name from remote path

Name	Type	Attribute	Description
repoPath	string		repository path

import {getRepoPathFromPayload} from 'github-wiki-notifier/src/repository.js'

Get remote repository path from payload object

Name	Type	Attribute	Description
payload	Object	optional	GitHub Webhook payload