Class: baseResource

baseResource

new baseResource(settings)

Represents a base class for all jira resources

Parameters:
Name Type Description
settings

The information needed to setup the resource

Properties
Name Type Description
name string

The name of jira model.

request *

The request function to use.

jiraApi jiraApi

The jiraApi library to use.

Source:

Methods

(static) loadCustom(fileName) → {Object}

loadCustom try to load custom definitions from a file. the definitions are applied in "method <- nodeable <- custom" order so that an end-user can override the standard (generated) defaults and the nodeable defaults

Parameters:
Name Type Description
fileName string

The name of the definition to load

Source:
Returns:

the json data in the file (if it exists) or an empty object {}

Type
Object

(static) loadDefinition()

loadDefinition each model can have a defintion file that overrides the generated settings in api.json for example, the strongloop remote api path can be changed to something more suitable

Parameters:
Name Type Description
settings.name string

The name of jira model.

Source:

makeRequest(method, verb, url, options, callbackopt) → {Promise.<any>}

makeRequest construct an http request based on the method definitions

Parameters:
Name Type Attributes Description
method string

The method to use

verb string

The http method to use (GET , PUT etc)

url string

The method api url

options Object

The data to send in the request

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

register()

register registers all the api methods with the model

Source: