Miss any of our Open RFC calls?Watch the recordings here! »

@hugojosefson/openmeal-api

4.0.0 • Public • Published

API for Open Meal Information

Build Status npm page License ISC SemVer 2.0.0 JavaScript Style Guide

Introduction

This is an unofficial API module for accessing Swedish school lunch menus from skolmaten.se via Open Meal Information as specified at https://orebrokommun.github.io/Open-Meal-Information/.

Prerequisite

Node.js, at least v10.13.0.

Recommended to install latest via nvm:

nvm install stable

Installation in a project

yarn add @hugojosefson/openmeal-api
 # or 
npm install --save @hugojosefson/openmeal-api

Programmatic access

It is recommended to import or require the module, and use its exported functions programmatically.

API

Table of Contents

getDataProviders

Returns data providers.

Parameters

Returns Promise A Promise of the data property of the response from the server.

getDataProviderSkolmaten

Returns the data provider with name === 'Skolmaten'.

Parameters

Returns Promise A Promise of the data property of the response from the server.

getDistributors

Returns distributors from a data provider.

Parameters
  • dataprovider object data provider object to fetch distributors from.
    • dataprovider.baseUrl string baseUrl of the data provider.

Returns Promise A Promise of the data property of the response from the server.

filterDistributors

Filters distributors based on partial name and/or partial address.

Parameters
  • options object
    • options.distributors Array current distributors to filter, for example from getDistributors or the result of previous call to this function.
    • options.name (string | undefined) if specified, only include distributors in result which contain this string in their name, case insensitively.
    • options.address (string | undefined) if specified, only include distributors in result which contain this string in their addressRegion or addressLocality, case insensitively.

Returns Promise<Array> A Promise of an array of distributors matching the criteria.

getMeals

Fetches meals for a distributor.

Parameters
  • options object
    • options.dataprovider object data provider object to fetch distributors from.
      • options.dataprovider.baseUrl string baseUrl of the data provider.
    • options.distributor object distributor whose meals to fetch.
      • options.distributor.distributorID string the distributor's ID.
    • options.startDate (string | undefined) start date on the form YYYY-MM-DD.
    • options.endDate (string | undefined) end date on the form YYYY-MM-DD.

Returns Promise A Promise of the data property of the response from the server.

extractOnlyMeals

Extracts an array of only meals objects from a response from getMeals().

Parameters
  • response object response from calling getMeals().

Returns Promise<Array> A Promise of an array containing all meal objects from the supplied response.

Usage on CLI

You can also try it from the command-line.

./node_modules/.bin/openmeal-api

Prints usage information for the CLI.

Install

npm i @hugojosefson/openmeal-api

DownloadsWeekly Downloads

26

Version

4.0.0

License

ISC

Unpacked Size

18 kB

Total Files

13

Last publish

Collaborators

  • avatar