Skip to content

github_rest_api

class PullRequest

PullRequest¶

A GitHub pull request. Provides a convenience method to fetch the files changed in this pull request.

class val PullRequest

Constructors¶

create¶

new val create(
  creds: Credentials val,
  number': I64 val,
  title': String val,
  body': (String val | None val),
  state': String val,
  labels': Array[Label val] val,
  base': PullRequestBase val,
  url': String val,
  html_url': String val,
  comments_url': String val)
: PullRequest val^

Parameters¶

creds: Credentials val
number': I64 val
title': String val
body': (String val | None val)
state': String val
labels': Array[Label val] val
base': PullRequestBase val
url': String val
html_url': String val
comments_url': String val

Returns¶

PullRequest val^

Public fields¶

let number: I64 val¶

let title: String val¶

let body: (String val | None val)¶

let state: String val¶

let labels: Array[Label val] val¶

let base: PullRequestBase val¶

let url: String val¶

let html_url: String val¶

let files_url: String val¶

let comments_url: String val¶

Public Functions¶

get_files¶

Fetches the files changed in this pull request.

fun box get_files()
: Promise[(Array[PullRequestFile val] val | RequestError val)] tag

Returns¶

Promise[(Array[PullRequestFile val] val | RequestError val)] tag