Mediumroast for GitHub API and SDK

Class: UserManager

UserManager

Manages GitHub user operations

new UserManager(octokit, orgName, repoName)

Parameters:
Name Type Description
octokit Object

Octokit instance
orgName String

GitHub organization name
repoName String

GitHub repository name
Source:

Methods

<async> addUserToRepository(username, permission)

Adds a user to the repository with specified permissions

Parameters:
Name Type Default Description
username String

GitHub username to add
permission String pull

Permission level ('pull', 'push', 'admin', 'maintain', 'triage')
Source:
Returns:

ResponseFactory result

Type
Promise.<Array>

<async> getAllUsers()

Gets all users (collaborators) from the repository

Source:
Returns:

ResponseFactory result

Type
Promise.<Array>

<async> getCurrentUser()

Gets the authenticated user from the GitHub API

Source:
Returns:

ResponseFactory result

Type
Promise.<Array>

<async> removeUserFromRepository(username)

Removes a user from the repository

Parameters:
Name Type Description
username String

GitHub username to remove
Source:
Returns:

ResponseFactory result

Type
Promise.<Array>