E

Direction

Show Usages
Defines four cardinal directions: Up, Right, Down, and Left.

Members

No filters for this type

Constants

DOWN

static
Represents the downward direction.
static

See Also

Developer's Guide

LEFT

static
Represents the leftward direction.
static

See Also

Developer's Guide

RIGHT

static
Represents the rightward direction.
static

See Also

Developer's Guide

UP

static
Represents the upward direction.
static

See Also

Developer's Guide

Static Methods

from

(value: Direction): Direction
static
Converts the given argument to an enum constant of this enum type.
Most notably, this method can convert an enum constant's name into the enum constant itself.
static

Parameters

value: Direction
The value to convert to an enum constant.

Return Value

Direction
The enum constant that corresponds to the given argument.

getName

(value: Direction): string
static
Returns the name of the given enum constant.
static

Parameters

value: Direction
The numeric value of an enum constant.

Return Value

string
The name of the enum constant.

Throws

Exception ({ name: 'Error' })
If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.