Class GistController

Controller for interacting via GitHub Gist API.

See IBaseController for more details.

Hierarchy

GistController

Implements

IBaseController

Index

Constructors

constructor

Properties

path
router

Methods

Constructors

constructor

new GistController(): GistController

- Defined in src/controllers/gist.ts:19
Constructor of GistController.

Returns GistController

Properties

path

path: string = gistUrl.main

router

router: Router = express.Router()

Methods

Private createGist

createGist(req: any, res: any): void

- Defined in src/controllers/gist.ts:165
Route to create a gist.

Parameters
- req: any
  
  Request object
- res: any
  
  Response object
Returns void

Private fetchAllGistsofUser

fetchAllGistsofUser(req: any, res: any): Promise<void>

- Defined in src/controllers/gist.ts:43
Route to fetch all private and public gists of a user.

Parameters
- req: any
  
  Request object
- res: any
  
  Response object
Returns Promise<void>

Private initializeRoutes

initializeRoutes(): void

- Defined in src/controllers/gist.ts:31
Initialization of routes of GistController.

Returns void

Private updateGist

updateGist(req: any, res: any): void

- Defined in src/controllers/gist.ts:207
Route to update a gist.

Parameters
- req: any
  
  Request object
- res: any
  
  Response object
Returns void

Static Private sanitize

sanitize(data: any, username: string): any

- Defined in src/controllers/gist.ts:247
Static method to sanitize the output fetched by GitHub gist API.

Parameters
- data: any
  
  Array of gists
- username: string
  
  Name of gist creator
Returns any

Static Private specUrlGenerator

specUrlGenerator(fileName: string, gistId: string, username: string): string

- Defined in src/controllers/gist.ts:285
Static method to generate raw URL

Parameters
- fileName: string
  
  Name of file
- gistId: string
  
  ID of gist
- username: string
  
  Name of gist creator
Returns string

Generated using TypeDoc