1.0.0 • Published 6 months ago
numa-wrapper v1.0.0
numa-wrapper
A simple API wrapper for aggregating campus resources.
Installation
You can install the package with npm:
$ npm install numa-wrapper
Usage
Here's a simple example of how you can use numa-wrapper to get recent news and upcoming events:
const uafs = require('numa-wrapper');
// Fetch page 1 news images
(async () => {
const news = await uafs.getNews({ page: 1 });
for (n of news) {
console.log(n.image);
}
});
// Fetch the next 50 upcoming event titles
(async () => {
const news = await uafs.getEvents();
for (n of news) {
console.log(n.title);
}
});
API
getNews({ page })
Fetches a list of news for a given page. Defaults to page 1.
Parameters:
page
(optional): The page number of news to retrieve. Defaults to1
if not provided.
Returns:
- An array of news objects, where each object contains information about a news item (e.g., title, image, description, title).
getEvents()
Fetches a list of the next 50 upcoming events.
Returns:
- An array of events objects, each containing details of an event (e.g., name, date, description).
1.0.0
6 months ago