jsg2021 / github-api

Wrapper for octokit based CLI tools

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Wrapper for octokit based CLI tools

The default export of this module is an async getter that will return an initialized and authenticated instance of OctoKit/Rest.

Secondary utilities

This also exports helper functions


dispatchEvent(to: string | Ref, eventType: string): Promise<void>

Dispatch an event to a repository on github.

Parameters:

Name Description Type
to A path or resolved reference to a github repo. string | RepositoryRef
eventType See GitHub's repositroy_dispatch docs. string

resolveGithubProject(dir: string): Ref

Given a directory, resolve the github remote. Parameters:

Name Description Type
dir A path to a directory string

Type Ref: object

Properties:

Name Type Description
owner string The owner account/organization
repo string The short name of the repository
repoId string The Full owner/repo name.
<style> hr {margin-top: 6em;} </style>

About

Wrapper for octokit based CLI tools


Languages

Language:JavaScript 100.0%