Nightly Pocket Measurement

    adopt-a-pet

    1.0.10 • Public • Published

    Adopt-a-Pet

    Greenkeeper badge

    Adopt-a-Pet API Client for Node

    Installation

    npm i adopt-a-pet
    

    Setup

    • Get API keys for your shelter
    • Set API key and ShelterId to environment variables: (optional)
      export ADOPT_API_KEY=xxx
      export SHELTER_ID=90641
    

    Usage:

    const AdoptPet = require('adopt-a-pet')
     
    // Instantiate the adopt-a-pet API Client
    // Parameters are not required if environment variables are set
    const adoptPet = new AdoptPet(shelterId, apiKey)
     
    //
    // Get all pets for current shelter
    //
    adoptPet.getPets()
    .then((pets) => {
      // returns an array of pet objects
      return pets;
    });
     
    //
    // Get a random pet from the list of current shelter pets
    //
    adoptPet.getRandomPet()
    .then((pet) => {
      // return the random pet object
      return pet;
    })
     
    //
    // Get pet details using a petId and boolean to limit details
    //
    adoptPet.getPetDetails(petId, true)
    .then((pet) => {
      // returns detailed pet object
      return pet;
    });

    Install

    npm i adopt-a-pet

    DownloadsWeekly Downloads

    11

    Version

    1.0.10

    License

    MIT

    Unpacked Size

    13.6 kB

    Total Files

    10

    Last publish

    Collaborators

    • lynnaloo