route
route<
Point>(points):NamedRoute<Point>
Names a route’s points, in the order it walks them:
route({ stall: [3, 0, -2], well: [8, 0, -6] }).
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Point extends string |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
points |
Readonly<Record<Point, RoutePoint>> |
Returns
Section titled “Returns”NamedRoute<Point>