https://github.com/weejewel/node-circulus-berkel

https://github.com/weejewel/node-circulus-berkel

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/weejewel/node-circulus-berkel
• Owner: WeeJeWel
• Created: 2024-08-18T09:36:55.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-18T10:12:24.000Z (5 months ago)
• Last Synced: 2024-12-06T14:23:58.483Z (about 2 months ago)
• Language: JavaScript
• Size: 27.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Circulus Berkel API Client

![NPM Version](https://img.shields.io/npm/v/circulus-berkel)

This Node.js module is a wrapper around the https://www.circulus.nl website, and can retrieve a JSON and iCal feed when providing a Zipcode + Number.

## Installation

```bash

$ npm i circulus-berkel

```

## Usage

### As Webserver

```bash

$ circulus-berkel

Server listening on http://0.0.0.0:3000

```

```http

GET http://localhost:3000/?zipCode=7411KT&number=1&format=ical

GET http://localhost:3000/?zipCode=7411KT&number=1&format=json

```

### As Dependency

```javascript

import CirculusBerkel from 'circulus-berkel';

const circulusBerkel = new CirculusBerkel({

  zipCode: '7411KT',

  number: '1',

});

const iCalFeed = await circulusBerkel.getIcalFeed();

console.log(iCalFeed);

const jsonFeed = await circulusBerkel.getJsonFeed();

console.log(jsonFeed);

```