Function getOppositeDirection

Returns the opposite direction to the given direction or null if the given direction has no opposite.

Example

getOppositeDirection("up"); // -> "down"
getOppositeDirection("down"); // -> "up"
getOppositeDirection("left"); // -> "right"
getOppositeDirection("right"); // -> "left"
getOppositeDirection("none"); // -> null
getOppositeDirection("ambiguous"); // -> null

Throws

LisnUsageError If the given view is not valid.

getOppositeDirection(direction: Direction): null | Direction
Parameters
- direction: Direction
Returns null | Direction
- Defined in packages/lisn.js/src/ts/utils/directions.ts:105