An open API service indexing awesome lists of open source software.

https://github.com/cdimascio/rx-ballparks-services


https://github.com/cdimascio/rx-ballparks-services

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

#rx-ballpark-services

Simple set of services used to fetch basic information and weather data about Major Baseball Parks.

Weather Data is provided by Weather Company Data for IBM Bluemix

## Usage

###Initialize

```javascript
import RxBallparkServices from 'rx-ballpark-services';

const rbs = RxBallparkServices({
weather: {
apiRoot:
}
});
```

###Initialize (try mode)

*Bluemix account 'not required'*

*Weather Company Data for IBM Bluemix 'not required'*

```javascript
import RxBallparkServices from 'rx-ballpark-services';

const rbs = RxBallparkServices({
weather: {
apiRoot: 'dummy',
useMockData: true
}
});
```

## Apis

### Fetch all ballparks with Weather

```javascript
rbs.BallparksWeatherService
.all()
.subscribe(r => /* do something */, /* handle error */);
```

### Fetch a ballpark by id

```javascript
rbs.BallparksService
.byId(req.params.id)
.subscribe(r => /* do something */, /* handle error */);
```