@mariolazzari/met NPM

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:

$ pnpm add @mariolazzari/met

Usage

Import package

import { Met } from "@mariolazzari/met"

Watch mode

pnpm test

Unit testing

pnpm test

Bulding new version

pnpm 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()

Types

Resukt

Discriminated union containing api calls: you can test success in order to get both value or error message.

type Result<T> =
  | {
      success: true;
      data: T;
    }
  | {
      success: false;
      error: string;
    };

Methods

Met client includes the following public methods:

getDepartments

Get full departments list.

 public async getDepartments(): Promise<Result<DepartmentsResponse>> {
    return await this.fetchData<DepartmentsResponse>('departments');
  }

getObject

search

Authors

Mario Lazzari - Initial work

@mariolazzari/met v0.1.0

Met