import GitHubWikiNotifier from 'github-wiki-notifier/src/index.js'

public class | source

GitHubWikiNotifier

Notify info of GitHub Wiki by specific notifier

Constructor Summary

Public Constructor
public	constructor(notifierName: string) Constructor

Public Members
public	notifier: *

Public Methods
public	notify(opts: Object): Promise notify to service
public	notifyFromPayload(payload: Object, opts: Object): Promise notify from payload
public	notifyFromRepository(repository: string, opts: Object): Promise notify from repository

Constructor

Name	Type	Attribute	Description
notifierName	string		notifier name

notify to service

Name	Type	Attribute	Description
opts	Object		options
opts.payload	Object	optional	GitHub Webhook payload
opts.repository	string	optional	path to repository directory
opts.cloneDir	string	optional	path to directory for cloning remote repository
opts.maxLength	number	optional	max length
opts.dryRun	boolean	optional	a flag for disable sending

notify from payload

Name	Type	Attribute	Description
payload	Object		GitHub Webhook payload
opts	Object		options
opts.cloneDir	string	optional	path to directory for cloning remote repository
opts.maxLength	number	optional	max length
opts.dryRun	boolean	optional	a flag for disable sending

notify from repository

Name	Type	Attribute	Description
repository	string		path to repository directory
opts	Object		options
opts.maxLength	number	optional	max length
opts.dryRun	boolean	optional	a flag for disable sending