Class APIObject

An API object

class: APIObject

Hierarchy

APIObject
- User

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new APIObject(basePath: string, config: IGitHubAPIConfig): APIObject

- Defined in struct/APIObject.ts:21
Creates an instance of APIObject.

memberof

APIObject

example

new APIObject( 'users', { path: 'haydennyyy' } ); // https://api.github.com/users/haydennyyy

Parameters
- basePath: string
  
  The base path
- config: IGitHubAPIConfig
  
  The configuration for the API object
Returns APIObject

Properties

Private base

base: string

Private conf

conf: IGitHubAPIConfig

Private httpOptions

httpOptions: object

raw

raw: object

url

url: string

Methods

endpoint

endpoint(path: string): Promise<any>

- Defined in struct/APIObject.ts:82
Makes a request to the GitHub API

memberof

APIObject

Parameters
- path: string
  
  The URI to request on
Returns Promise<any>

init

init(): void

- Defined in struct/APIObject.ts:95
Gets the raw JSON from the API.

type

{Promise}

Returns void

Generated using TypeDoc