❤
npm
Sign UpSign In

lyft-node

0.0.5 • Public • Published

Build Status Coverage Status npm version

NPM

A Node Wrapper for the Lyft API

Introduction

A simple node wrapper that serves as an abstraction for the Lyft API's public scope endpoints.

Installation

Install via NPM

npm install lyft-node

Usage

Get Ride Types

Takes a ride types search query and returns a response wrapped in a Promise.

Ride Types Search Query

Required:
  • start [coordinate]
Optional:
  • rideType [string] (must be lyft, lyft_line, or lyft_plus)

Example

import Lyft from 'lyft-node';
 
const lyft = new Lyft('LYFT_CLIENT_ID', 'LYFT_CLIENT_SECRET');
 
const query = {
  start: {
      latitude: 1,
      longitude: 2,
    },
};
 
lyft.getRideTypes(query)
  .then((result) => {
    console.log(result);
  })
  .catch((error) => {
    console.log(error);
  });

Get Driver ETA

Takes a driver eta search query and returns a response wrapped in a Promise.

Driver ETA Search Query

Required:
  • start [coordinate]
Optional:
  • end [coordinate]
  • rideType [string] (must be lyft, lyft_line, or lyft_plus)

Example

import Lyft from 'lyft-node';
 
const lyft = new Lyft('LYFT_CLIENT_ID', 'LYFT_CLIENT_SECRET');
 
const query = {
  start: {
      latitude: 1,
      longitude: 2,
    },
};
 
lyft.getDriverEta(query)
  .then((result) => {
    console.log(result);
  })
  .catch((error) => {
    console.log(error);
  });

Get Ride Estimates

Takes a ride estimates search query and returns a response wrapped in a Promise.

Ride Estimates Search Query

Required:
  • start [coordinate]
  • end [coordinate]
  • rideType [string] (must be lyft, lyft_line, or lyft_plus)

Example

import Lyft from 'lyft-node';
 
const lyft = new Lyft('LYFT_CLIENT_ID', 'LYFT_CLIENT_SECRET');
 
const query = {
  start: {
      latitude: 1,
      longitude: 2,
    },
    end: {
      latitude: 3,
      longitude: 4,
    },
    rideType: 'lyft',
};
 
lyft.getRideEstimates(query)
  .then((result) => {
    console.log(result);
  })
  .catch((error) => {
    console.log(error);
  });

Get Nearby Drivers

Takes a nearby drivers search query and returns a response wrapped in a Promise.

Time Estimates Search Query

Required:
  • start [coordinate]

Example

import Lyft from 'lyft-node';
 
const lyft = new Lyft('LYFT_CLIENT_ID', 'LYFT_CLIENT_SECRET');
 
const query = {
  start: {
      latitude: 1,
      longitude: 2,
    },
};
 
lyft.getNearbyDrivers(query)
  .then((result) => {
    console.log(result);
  })
  .catch((error) => {
    console.log(error);
  });

License

MIT

Credits

This project is heavily inspired by Jae Bradley's uber-client

Readme

Keywords

Package Sidebar

Install

npm i lyft-node

Repository

github.com/djchie/lyft-node

Homepage

github.com/djchie/lyft-node#readme

Weekly Downloads

6

Version

0.0.5

License

MIT

Last publish

Collaborators

  • djchie
Try on RunKit
Report malware