HasDescription

HasDescription

Abstract class

This is an abstract class and should not be used directly. You should use one of the extended classes, or extend the class yourself.

A base class for description functionality.

Kind: global abstract class

hasDescription.description ⇒ Description | null

The description for the group.

Kind: instance property of HasDescription

hasDescription.description

Set the description on the group.

Kind: instance property of HasDescription

ParamType
descriptionDescription | string | null

hasDescription.toJSON() ⇒ Object

Return an object for JSON serialising.

This is called automatically when JSON encoding the object.

Kind: instance method of HasDescription

hasDescription.toString() ⇒ string

Return the String representation of the object.

This is called automatically when casting the object to a string.

Kind: instance method of HasDescription
See: RollGroup#notation