More Documentation Improvements (#2)

Author: PalaashPandey

src/api.ts

@@ -3,7 +3,7 @@
  * @param {string} auth Authentication to use for the request
  * @returns {Route[]} list of all active routes
  */
-export async function getBaseData(auth: string) {
+export async function getRoutes(auth: string) {
     var res = await fetch(`https://ridebtd.org/Services/JSONPRelay.svc/GetRoutesForMapWithScheduleWithEncodedLine?apiKey=${auth}&isDispatch=false`)
 
     return await res.json()
@@ -14,7 +14,7 @@ export async function getBaseData(auth: string) {
  * @param {string} auth authentication to use for the request
  * @returns {Vehicle[]} list of all locations for buses that are active
 */
-export async function getVehicleLocations(auth: string) {
+export async function getMapVehicles(auth: string) {
     var res = await fetch(`https://ridebtd.org/Services/JSONPRelay.svc/GetMapVehiclePoints?apiKey=${auth}&isPublicMap=true`)
 
     return await res.json()
@@ -26,7 +26,7 @@ export async function getVehicleLocations(auth: string) {
  * @param {string} auth authentication to use for the request
  * @returns {RouteStop[]} list of stop times for the given routes
 */
-export async function getNextStopTimes(routes: string[], auth: string) {
+export async function getStopArrivalTimes(routes: string[], auth: string) {
     var res = await fetch(`https://ridebtd.org/Services/JSONPRelay.svc/GetStopArrivalTimes?apiKey=${auth}&routeIds=${routes.join(",")}&version=2`)
 
     return await res.json()

types/index.d.ts

@@ -127,22 +127,22 @@ declare module 'brazos-transit-api' {
      * @param {string} auth Authentication to use for the request
      * @returns {Route[]} list of all active routes
      */
-    export async function getBaseData(auth: string): Promise<Route[]> 
+    export async function getRoutes(auth: string): Promise<Route[]> 
 
     /**
      * get a list of all locations for all buses that are active
      * @param {string} auth authentication to use for the request
-     * @returns {Vehicle[]} list of all locations for buses that are active
+     * @returns {Vehicle[]} list of all buses that are active
     */
-    export async function getVehicleLocations(auth: string): Promise<Vehicle[]>
+    export async function getMapVehicles(auth: string): Promise<Vehicle[]>
 
     /**
      * get the next stop times for a given route(s)
      * @param {string[]} routes route ids to get stop times for
      * @param {string} auth authentication to use for the request
      * @returns {RouteStop[]} list of stop times for the given routes
     */
-    export async function getNextStopTimes(routes: string[], auth: string): Promise<RouteStop[]>
+    export async function getStopArrivalTimes(routes: string[], auth: string): Promise<RouteStop[]>