Module: github-user-activity-cmd

The command line interface for github-user-activity module.
Version:
  • 1.0.0
Author:
  • Essam A. El-Sherif
Source:

Members

(static, constant) cmdOptions :object

Command line arguments.
Type:
  • object
Source:

(static) githubUser :string

The GitHub username given as a command line argument.
Type:
  • string
Source:

(inner, constant) CMD :string

The command line interface.
Type:
  • string
Source:

(inner, constant) CMD_VER :string

The command line interface version.
Type:
  • string
Source:

Methods

(static) getError(Error) → {string}

Function to return error messages.
Parameters:
Name Type Description
Error number number.
Source:
Returns:
Error message.
Type
string

(static) getEvents() → {Map}

Function to return a Map of GitHub events.
Source:
See:
Returns:
Map of GitHub event types to event descriptions.
Type
Map

(static) parseCmdLine()

Command line parser function.
Source:

(inner) getHelp() → {string}

Function to return help info.
Source:
Returns:
Type
string