# @types/pet-finder-api

> TypeScript definitions for pet-finder-api

Latest version **1.0.4** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/pet-finder-api
pnpm add @types/pet-finder-api
yarn add @types/pet-finder-api
bun add @types/pet-finder-api
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2023-11-07 |
| First published | 2017-05-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51442 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/pet-finder-api
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pet-finder-api
- npm.io page: https://npm.io/package/@types/pet-finder-api

## Recent versions

- 1.0.4 (latest) — 2023-11-07
- 1.0.1 (ts2.0) — 2019-03-11
- 1.0.3 — 2023-10-18
- 1.0.2 — 2023-09-24
- 1.0.0 — 2017-05-04

## README

# Installation
> `npm install --save @types/pet-finder-api`

# Summary
This package contains type definitions for pet-finder-api (https://github.com/drlukeangel/Pet-Finder-API-Javascript-Library).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pet-finder-api.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pet-finder-api/index.d.ts)
````ts
declare function petFinder(api_key: string, api_secret: string, options?: any): petFinder.PetFinder;

declare namespace petFinder {
    interface PetFinder {
        getBreedList(animal: string, callback: (err: any, breedArray: string[]) => void): void;
        getPet(petId: number, options: any, callback: (error: any, pet: Pet) => void): void;
        getRandomPet(options: any, callback: (error: any, pet: Pet) => void): void;
        findPet(options: any, callback: (error: any, pets: Pet[]) => void): void;
        findShelter(location: string, options: any, callback: (error: any, shelters: Shelter[]) => void): void;
        getShelter(shelterId: string, options: any, callback: (error: any, shelter: Shelter) => void): void;
        getPetsInShelter(shelterId: string, options: any, callback: (error: any, pets: Pet[]) => void): void;
        getSheltersWithBreeds(
            animal: string,
            breed: string,
            options: any,
            callback: (error: any, shelters: Shelter[]) => void,
        ): void;
    }

    interface Pet {
        id: number;
        name: string;
        status: string;
        description: string;
        sex: string;
        age: string;
        size: string;
        mix: string;
        animal: string;
        shelterId: string;
        shelterPetId: string;
        contact: Contact;
        options: string[];
        breeds: string[];
        media: any;
    }

    interface Shelter {
        id: string;
        name: string;
        email: string;
        phone: string;
        fax: string;
        address1: string;
        address2: string;
        city: string;
        state: string;
        zip: string;
        country: string;
        longitude: number;
        latitude: number;
    }

    interface Contact {
        email: string;
        phone: string;
        fax: string;
        address1: string;
        address2: string;
        city: string;
        state: string;
        zip: string;
    }
}

export = petFinder;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [ncipollina](https://github.com/ncipollina).

---
_Source: https://npm.io/package/@types/pet-finder-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._