@mariolazzari/met

Met

This package is a TypeScript based wrapper around the public REST APIs of Metropolitan museum of Art (New York).

Prerequisites

This package requires NodeJS (version 18 or later) and a node package manager (Npm, Yarn, Pnpm or Bun).

To make sure you have them available on your machine, try running the following command.

npm -v && node -v
v10.1.0
v20.9.0

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

BEFORE YOU INSTALL: please read the prerequisites.

Start with cloning this repo on your local machine:

$ git clone https://github.com/mariolazzari/met.git
$ cd met

To install and set up the library, run:

$ npm install @mariolazzari/met

Usage

Import package

import { Met } from "@mariolazzari/met"

Watch mode

npm test

Unit testing

npm test

Bulding new version

npm build

This task will create a distribution version of the project inside your local dist/ folder

Met class

Met class content handles all the requests and the responses to the Metropolitan museum of Art public REST APIs.

Constructor

In order to initialize Met client:

const met = new Met()

Methods

Met client includes the following public methods:

getDepartments

getObject

search

Authors

• Mario Lazzari - Initial work

Links

• Demo app
• My personal site
• My github profile
• Metropolitan Museum of Art APIs documentation