1.1.0 • Published 2 years ago

trash-pickup-belgium v1.1.0

Weekly downloads
4
License
MIT
Repository
github
Last release
2 years ago

Belgium Trash Pickup

Travis build status Current version Downloads on npm License Dependencies

Simple library to fetch trashpickups in Belgium (Ophaalkalender). It wraps around the API that is powering ophaalkalender.be.

The library uses Promises and supports async/await. It also uses classes so an up-to-date version of node is required.

Usage

Load the library:

const TrashPickupFinder = require('trash-pickup-belgium');

Initialize

Initialize with an streetname and zipcode:

const trashPickupFinder = new TrashPickupFinder({
    streetName: 'Korenmarkt',
    zipcode: '9000'
});

Or initialize with a streetId (this reduces the number of API calls to 1)

const trashPickupFinder = new TrashPickupFinder({
    streetId: '46537',
});

Fetch the pickups for this week

This fetches the trash pickups that are scheduled this week:

trashPickupFinder.getTrashPickupsThisWeek().then((pickupData) => {
    console.log("Pickups this week:", pickupData);
});

Example return data:

[
    {
        "allDay": true,
        "color": "blue",
        "start": "2018-01-04T00:00:00+01:00",
        "title": "PMD"
    },
    {
        "allDay": true,
        "color": "grey",
        "start": "2018-01-04T00:00:00+01:00",
        "title": "Restafval"
    }
]

Fetching all pickups for your street

Returns all pickups for your street (usually for the entire year):

trashPickupFinder.getTrashPickups().then((pickupData) => {
    console.log(pickupData);
});

Return data will look like this:

[
    {
        "allDay": true,
        "color": "blue",
        "start": "2018-01-04T00:00:00+01:00",
        "title": "PMD"
    },
    {
        "allDay": true,
        "color": "grey",
        "start": "2018-01-04T00:00:00+01:00",
        "title": "Restafval"
    },
    {
        "allDay": true,
        "color": "brown",
        "start": "2018-01-11T00:00:00+01:00",
        "title": "P-K"
    },
    {
        "allDay": true,
        "color": "yellow",
        "start": "2018-01-11T00:00:00+01:00",
        "title": "Glas"
    },
    {
        "allDay": true,
        "color": "green",
        "start": "2018-01-11T00:00:00+01:00",
        "title": "GFT"
    },
    {
        "allDay": true,
        "color": "purple",
        "start": "2018-01-18T00:00:00+01:00",
        "title": "Grof huisvuil afroep"
    }
]

License & contribution

MIT license (see LICENSE file)

Found a bug? Have ideas for improvements? Everything is welcome!

Open issues or create pull requests to contribute.

Changelog

1.1.0

  • Added the ability to fetch the pickups for this week.
  • Added documentation on how you can pass streetId to reduce the amount of API calls needed.

v1.0.0

  • Initial release
1.1.0

2 years ago

1.0.0

3 years ago