Check if a pull request has been merged | Sample

3 parameters

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

pull_numberintegerrequired

The number that identifies the pull request.

2 status codes

204Response if pull request has been merged

404Not Found if pull request has not been merged

Error handling

A 404 is returned: Not Found if pull request has not been merged.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.merge.list({
  owner: "octocat",
  repo: "hello-world",
  pullNumber: "example",
});

Request

Response

Errors