Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hugojosefson/openmeal-api

API module for skolmaten.se via Open Meal Information API
https://github.com/hugojosefson/openmeal-api

api lunch meal openmeal skola skollunch skolmat skolmaten unofficial

Last synced: 29 days ago
JSON representation

API module for skolmaten.se via Open Meal Information API

Host: GitHub
URL: https://github.com/hugojosefson/openmeal-api
Owner: hugojosefson
Created: 2018-02-20T11:35:20.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2023-03-04T03:40:54.000Z (almost 2 years ago)
Last Synced: 2024-11-20T13:56:14.206Z (about 1 month ago)
Topics: api, lunch, meal, openmeal, skola, skollunch, skolmat, skolmaten, unofficial
Language: JavaScript
Homepage: https://npmjs.com/package/@hugojosefson/openmeal-api
Size: 1.73 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 11
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        # API for Open Meal Information

[![Build Status](https://travis-ci.org/hugojosefson/openmeal-api.svg?branch=master)](https://travis-ci.org/hugojosefson/openmeal-api)

[![npm page](https://img.shields.io/npm/v/@hugojosefson/openmeal-api.svg)](https://npmjs.com/package/@hugojosefson/openmeal-api)

[![License ISC](https://img.shields.io/npm/l/@hugojosefson/openmeal-api.svg)](https://tldrlegal.com/license/-isc-license)

[![SemVer 2.0.0](https://img.shields.io/badge/SemVer-2.0.0-lightgrey.svg)](http://semver.org/spec/v2.0.0.html)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Introduction

This is an unofficial API module for accessing Swedish school lunch

menus from [skolmaten.se](https://skolmaten.se/) via Open Meal

Information as specified at

.

## Prerequisite

Node.js, at least `v10.13.0`.

Recommended to install latest via [nvm](https://github.com/creationix/nvm#readme):

```bash

nvm install stable

```

## Installation in a project

```bash

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](#getdataproviders)

    -   [Parameters](#parameters)

-   [getDataProviderSkolmaten](#getdataproviderskolmaten)

    -   [Parameters](#parameters-1)

-   [getDistributors](#getdistributors)

    -   [Parameters](#parameters-2)

-   [filterDistributors](#filterdistributors)

    -   [Parameters](#parameters-3)

-   [getMeals](#getmeals)

    -   [Parameters](#parameters-4)

-   [extractOnlyMeals](#extractonlymeals)

    -   [Parameters](#parameters-5)

#### getDataProviders

Returns data providers.

##### Parameters

-   `dataprovidersJsonUrl` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** url for the data providers json. Defaults to  as per 

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A Promise of the data property of the response from the server.

#### getDataProviderSkolmaten

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

##### Parameters

-   `dataprovidersJsonUrl` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** url for the data providers json. Defaults to  as per 

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** A Promise of the data property of the response from the server.

#### getDistributors

Returns distributors from a data provider.

##### Parameters

-   `dataprovider` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** data provider object to fetch distributors from.

    -   `dataprovider.baseUrl` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** baseUrl of the data provider.

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 

    -   `options.distributors` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** current distributors to filter, for example from getDistributors or the result of previous call to this function.

    -   `options.name` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** if specified, only include distributors in result which contain this string in their name, case insensitively.

    -   `options.address` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** if specified, only include distributors in result which contain this string in their addressRegion or addressLocality, case insensitively.

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)>** A Promise of an array of distributors matching the criteria.

#### getMeals

Fetches meals for a distributor.

##### Parameters

-   `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 

    -   `options.dataprovider` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** data provider object to fetch distributors from.

        -   `options.dataprovider.baseUrl` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** baseUrl of the data provider.

    -   `options.distributor` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** distributor whose meals to fetch.

        -   `options.distributor.distributorID` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the distributor's ID.

    -   `options.startDate` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** start date on the form YYYY-MM-DD.

    -   `options.endDate` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \| [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** end date on the form YYYY-MM-DD.

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** response from calling getMeals().

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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.

```bash

./node_modules/.bin/openmeal-api

```

Prints usage information for the CLI.