Class: KssParameter

kss. KssParameter

new KssParameter(data)

An instance of this class is returned on calling KssSection.parameter. Exposes convenience methods for interpreting data.

Parameters:
Name Type Description
data Object

A part of the data object passed on by KssSection.

Source:

Methods

description() → {string}

Returns the description of the parameter.

Source:
Returns:

The description of the parameter.

Type
string

(private) init()

Initializes the object and data passed to the constructor. Called automatically from the KssParameter() constructor; should not be called directly.

Source:

name() → {string}

Returns the name of the parameter.

Source:
Returns:

The name of the parameter.

Type
string

section() → {KssSection}

Returns the KssSection object this parameter is associated with.

Source:
Returns:

The style guide section the parameter belongs to.

Type
KssSection