Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JenkinsCI

Hierarchy

  • JenkinsCI

Index

Constructors

Methods

Constructors

constructor

  • new JenkinsCI(__namedParameters: { jenkinsHost: string; options: Options; token: string; username: string }): JenkinsCI

  • Parameters

    • __namedParameters: { jenkinsHost: string; options: Options; token: string; username: string }
      • jenkinsHost: string
      • options: Options
      • token: string
      • username: string

    Returns JenkinsCI

Methods

defaults

getBuild

  • getBuild(buildPath: string): Promise<Build>

  • Gets details about a build

    Parameters

    • buildPath: string

      Required, the path to the build

    Returns Promise<Build>

getBuilds

  • getBuilds(jobName: string): Promise<Builds>

  • Gets build details for a job

    Parameters

    • jobName: string

      Required, the path to the build

    Returns Promise<Builds>

getJob

  • getJob(jobName: string): Promise<Job>

getJobs

  • getJobs(folderName?: undefined | string): Promise<Jobs>

  • Parameters

    • Optional folderName: undefined | string

    Returns Promise<Jobs>

getUser

  • getUser(user?: undefined | string): Promise<User>

  • Gets details about a Jenkins user, or the authenticating user

    Parameters

    • Optional user: undefined | string

      Optional, the username of a Jenkins user about which information should be returned

    Returns Promise<User>

me

  • me(): Promise<User>

Generated using TypeDoc