Class Api

Hierarchy

Api

Index

Constructors

constructor

Properties

context

Methods

Constructors

constructor

new Api(context: ApiContext): Api

- Defined in src/lib/api.ts:28
Parameters
- context: ApiContext
Returns Api

Properties

context

context: ApiContext

Methods

createRoute

createRoute(options: CreateRouteOptions): Promise<Route>

- Defined in src/lib/api.ts:42
Parameters
- options: CreateRouteOptions
Returns Promise<Route>

getLandmark

getLandmark(landmarkId: string): Promise<Landmark | null>

- Defined in src/lib/api.ts:34
Parameters
- landmarkId: string
Returns Promise<Landmark | null>

getLandmarks

getLandmarks(): Promise<Landmark[]>

- Defined in src/lib/api.ts:38
Returns Promise<Landmark[]>

getRoute

getRoute(routeId: string): Promise<Route | null>

- Defined in src/lib/api.ts:54
Retrieves the route routeId.

If the route is not found, return null.

Parameters
- routeId: string
Returns Promise<Route | null>

getRoutes

getRoutes(params: GetRoutesOptions): Promise<PartialRoute[]>

- Defined in src/lib/api.ts:58
Parameters
- params: GetRoutesOptions
Returns Promise<PartialRoute[]>

getUser

getUser(userId: string): Promise<User | null>

- Defined in src/lib/api.ts:62
Parameters
- userId: string
Returns Promise<User | null>

getWaypoint

getWaypoint(waypointId: string): Promise<Waypoint | null>

- Defined in src/lib/api.ts:66
Parameters
- waypointId: string
Returns Promise<Waypoint | null>

Static create

create(options: CreateApiOptions): Promise<Api>

- Defined in src/lib/api.ts:16
Parameters
- options: CreateApiOptions
Returns Promise<Api>

Generated using TypeDoc