Git Product home page Git Product logo

untis-js's Introduction

untis-js

WebUntis client for Node.js

This library lets you interact with and fetch content from WebUntis instances you are registered at.

Installation

npm install untis-js

Usage

untis-js is an ESM-only module - you are not able to import it with require. If you want to use it in a CommonJS project, you can use the async import() function from CommonJS to load untis-js asynchronously:

const untis = (...args) => import("untis-js").then(({ default: untis }) => untis(...args));

Alternatively, consider switching to ESM by renaming your .js files to .mjs or adding "type": "module" in your package.json file. This will allow you to import modules with the import keyword. Check out this post for more information on switching to ESM.

Example

import untis from "untis-js";

const schools = await untis.searchSchools("My Hero Academia");

const client = untis.client(schools[0]);

await client.authenticate("username", "password");

const subjects = await client.fetchAllSubjects();
console.log(subjects);

const timetable = await client.fetchCurrentTimetable();
console.log(timetable);

Also note that this library has only been tested with Node.js v14 and above.

Dependencies

This library uses node-fetch

License

This library is licensed under the MIT license. See LICENSE for more details.

untis-js's People

Contributors

thatmarcel avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.