Module: api

On this page

Source: api/index.js, line 1

Requires

Methods

(async, static) /api(req, res)

This endpoint displays the card on the browser

Parameters:

Name Type Description

req

Object

Request object

Properties

Name Type Description

query

Object

Query object

Properties

Name	Type	Description
`user`	string	Github username
`theme`	string	Theme name
`n`	number	Number of gists to display
`title`	string	Title of the card

res

Object

Response object

Source: api/index.js, line 11

(async, static) /api/pin(req, res)

This endpoint displays the card on the browser

Parameters:

Name Type Description

req

Object

Request object

Properties

Name Type Description

query

Object

Query object

Properties

Name	Type	Description
`user`	string	Github username
`id`	string	Gist id
`theme`	string	Theme name
`owner`	boolean	Show gist owner

res

Object

Response object

Source: api/pin.js, line 11