Options
All
  • Public
  • Public/Protected
  • All
Menu

@dxdeveloperexperience/hygie

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

CronType

GithubEvent

All Github Events supported by our API

GitlabEvent

All Gitlab Events supported by our API

Variables

Const RulesProviders

RulesProviders: any = RulesValues.map(rule => ({provide: rule,useClass: rule as any,}))

Const RulesValues

RulesValues: Rule[] = Object.values(require('./index')).map(rule => rule as Rule,)

Const RunnablesProviders

RunnablesProviders: any = RunnablesValues.map(runnable => ({provide: runnable,useClass: runnable as any,}))

Const RunnablesValues

RunnablesValues: Runnable[] = Object.values(require('./index')).map(runnable => runnable as Runnable,)

Const analytics

analytics: Visitor = ua(process.env.ANALYTICS_ID)

Let app

app: TestingModule

Const cron1

cron1: CronInterface[] = [{filename: 'cron-1-1.rulesrc',projectURL: 'https://github.com/zenika-open-source/hygie',},{filename: 'cron-1-2.rulesrc',projectURL: 'https://github.com/zenika-open-source/hygie',},{filename: 'cron-1-3.rulesrc',projectURL: 'https://github.com/zenika-open-source/hygie',},]

Const cron2

cron2: CronInterface[] = [{filename: ['cron-2-1-1.rulesrc','cron-2-1-2.rulesrc','cron-2-1-3.rulesrc',],projectURL: 'https://github.com/zenika-open-source/hygie',},{filename: 'cron-2-2.rulesrc',projectURL: 'https://github.com/zenika-open-source/hygie',},{filename: 'cron-2-3.rulesrc',projectURL: 'https://github.com/zenika-open-source/hygie',},]

Let dataAccessService

dataAccessService: DataAccessService

Const fs

fs: any = require('fs-extra')

Const githubService

githubService: GithubService = new GithubService(new HttpService())

Const gitlabService

gitlabService: GitlabService = new GitlabService(new HttpService())

Const isProduction

isProduction: boolean = process.env.NODE_ENV === 'production'

Const logger

logger: Logger = createLogger({level: 'debug',format: loggerFormat,transports: [new transports.Console()],})

Provide methods to log any type of informations: info(), warn(), error()...

Const loggerConstFormat

loggerConstFormat: Format = (loggerFormat = format.combine(format.printf(info => {let project = '';let location = '';let date = '';if (verboseLogger && info.project !== undefined) {project = `[${info.project}]`;}if (verboseLogger && info.location !== undefined) {location = `[${info.location}]`;}if (!isProduction) {date = `[${info.timestamp}]`;}return `[${info.level}]${date}${project}${location}: ${info.message}`;}),))

Let loggerFormat

loggerFormat: any

Const path

path: any = require('path')

Const verboseLogger

verboseLogger: boolean = process.env.VERBOSE_LOGGER === 'true'

Const webhook

webhook: Webhook = new Webhook(gitlabService, githubService)

Functions

CronExpressionException

  • CronExpressionException(msg: string): void

CronFilenameException

  • CronFilenameException(msg: string): void

FileSizeException

  • FileSizeException(file: string): void

RuleDecorator

  • RuleDecorator(ruleName: any): ClassDecorator

RunnableDecorator

  • RunnableDecorator(runnableName: any): ClassDecorator

SchedulerException

  • SchedulerException(msg: string): void

bootstrap

  • bootstrap(): Promise<void>

checkCronExpression

  • checkCronExpression(cronExpression: string): boolean

checkCronFilename

  • checkCronFilename(filename: any): boolean

convertCommitStatus

convertCronType

convertIssuePRSearchState

convertIssueState

getAllComments

  • getAllComments(content: string): string[]

getAllOptions

  • getAllOptions(): object

getAllRules

  • getAllRules(): object

getAllRunnables

  • getAllRunnables(): object

getAllYAMLOptions

  • getAllYAMLOptions(): object

getAllYAMLRulesName

  • getAllYAMLRulesName(): object

getAllYAMLRulesOptions

  • getAllYAMLRulesOptions(): object

getAllYAMLRunnablesArgs

  • getAllYAMLRunnablesArgs(): object

getAllYAMLRunnablesName

  • getAllYAMLRunnablesName(): object

getCronFileName

  • getCronFileName(str: string): string

getMatchingFiles

  • getMatchingFiles(commits: WebhookCommit[], type: string): string[]

getYAMLSchema

  • getYAMLSchema(): object

isCronInterface

  • isCronInterface(cron: CronType): boolean

isCronInterfaceArray

  • isCronInterfaceArray(cron: CronType): boolean

isGithubClosedPREvent

isGithubDeletedBranchEvent

isGithubIssueCommentEvent

isGithubIssueEvent

isGithubMergedPREvent

isGithubNewBranchEvent

isGithubNewPREvent

isGithubNewRepoEvent

isGithubPRCommentEvent

isGithubPushEvent

isGithubReopenedPREvent

isGitlabClosedPREvent

isGitlabDeletedBranchEvent

isGitlabIssueCommentEvent

isGitlabIssueEvent

isGitlabMergedPREvent

isGitlabNewBranchEvent

isGitlabNewPREvent

isGitlabPRCommentEvent

isGitlabPushEvent

isGitlabReopenedPREvent

makeBody

  • makeBody(to: string, subject: string, message: string): string

Object literals

Const cron3

cron3: object

filename

filename: string[] = ['cron-3-1-1.rulesrc', 'cron-3-1-2.rulesrc', 'cron-3-1-3.rulesrc']

projectURL

projectURL: string = "https://github.com/zenika-open-source/hygie"

Const cron4

cron4: object

filename

filename: string = "cron-4-1.rulesrc"

projectURL

projectURL: string = "https://github.com/zenika-open-source/hygie"

Const cron5

cron5: object

filename

filename: string = "rule-cron-4-1.yml"

projectURL

projectURL: string = "https://github.com/zenika-open-source/hygie"

Generated using TypeDoc