furrymap-api

0.2.2 • Public • Published

furrymap-api

Simple furrymap client.

Right now this only allows fetching data from the website.

For simple example usage, please see the test folder and the source, it's fully documented :).

constructor(Object settings)

All settings:

{
    cacheName: string = furrymapCache.json,
    credentials: { //OPTIONAL
        username: string,
        password: string
    }
}

Promise.<{users: FurrymapProfile[], markers: FurrymapMarker[]}> FurryMap.search(searchString: string, filter: string)

Performs a search for markers and/or users.

Promise.<FurrymapFullProfile> FurryMap.getProfile(userName: string)

Fetches a full profile.

Promise.<FurrymapMarker2[]> FurryMap.loadMarkers(forceRefresh: boolean)

Downloads the marker data(all markers) and caches them.

Readme

Keywords

Package Sidebar

Install

npm i furrymap-api

Weekly Downloads

3

Version

0.2.2

License

MIT

Last publish

Collaborators

  • simonschick