toScaleModeString

[ Function ]

public static toScaleModeString(
    value: string,
    defaultValue: ScaleModeString | null = null
): ScaleModeString | null;

Checks if a value is a scale and returns it.

Parameter

Name

Type

Description

value

string

The value to convert.

defaultValue

ScaleModeString, null

This value is returned if the first parameter is not valid. Null applies if this parameter is not passed.

Return value

Type

Description

ScaleModeString, null

Returns the appropriate value or null in the event of an error.

toScaleModeString 1:

Available from 1.8