Check if a user follows another user | Sample

2 parameters

usernamestringrequired

The handle for the GitHub user account.

target_userstringrequired

2 status codes

204if the user follows the target user

404if the user does not follow the target user

Error handling

A 404 is returned: if the user does not follow the target user.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.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.following.get({
  username: "octocat",
  targetUser: "example",
});

Was this helpful?

Request

Response

Errors