npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@leventhan/fostplus-api-wrapper

v1.0.3

Published

Wrapper for fostplus API

Downloads

289

Readme

FostPlus API Wrapper

Codacy Badge Daily Test

A TypeScript wrapper for the Fost Plus API, providing methods to access waste collection data and generate iCalendar files.

Installation

npm install @leventhan/fostplus-api-wrapper

Usage

This simple example will use all available methods.

const FostPlusAPI = require('@leventhan/fostplus-api-wrapper').default
const fs = require('fs');
const path = require('path');


const api = new FostPlusAPI({
  xConsumer: process.env.CONSUMER_UNIQUE_KEY || 'your_consumer_id', // should be obtained from Fostplus itself however since this field is publicly available you can scrape the web for it (or my tests)
});

(async () => {
    try{
        // Step 1: Zipcode data using a valid zipcode as param
        const zipcodesResponse = await api.getZipcodes("2880");
        // Display the list of zipcodes
        /*
            console.log('\nAvailable Zipcodes:');
            zipcodesResponse.items.forEach((item, index) => {
            console.log(`${index + 1}. ${item.code} - ${item.name}`);
            });
        */

        // Step 2: Select a zipcode (we select the first as default)
        const selectedZipcode = zipcodesResponse.items[0];

        const zipcodeId = selectedZipcode.id;
        console.log(`\nSelected Zipcode ID: ${zipcodeId}`);

        // Step 3: Get street query data by street name
        const streetsResponse = await api.getStreets("Sint-Amandsesteenweg", zipcodeId);
        // Display the list of streets
        /*
            console.log('\nAvailable Streets:');
            streetsResponse.items.forEach((item, index) => {
            console.log(`${index + 1}. ${item.name}`);
            });
        */

        // Step 4: Select a street (we select the first as default)
        const selectedStreet = streetsResponse.items[0];

        const streetId = selectedStreet.id;
        console.log(`\nSelected Street ID: ${streetId}`);

        // Step 5: date range
        const fromDate = "2024-10-19"
        const untilDate = "2024-11-02"

        // Step 6: house number
        const houseNumber = "80"

        // Step 7: Generate the iCalendar file
        const icsContent = await api.generateICalendar(
            zipcodeId,
            streetId,
            houseNumber,
            fromDate,
            untilDate
        );

        // Step 8: Save the iCalendar content to a file
        const filePath = path.join(__dirname, 'trash_collection_calendar.ics');

        fs.writeFile(filePath, icsContent, (err) => {
        if (err) {
            console.error('Error saving iCalendar file:', err);
        } else {
            console.log(`\niCalendar file has been saved to ${filePath}`);
        }
        });

    } catch (error) {
      console.error('Error generating iCalendar:', error);
    }
  })();