rijksmuseum-typescript-api/README.md

Rijksmuseum API Wrapper made with Typescript and RxJS

# rijksmuseum-typescript-api
Rijksmuseum API Wrapper made with Typescript and RxJS

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rijksmuseum-typescript-api&metric=alert_status)](https://sonarcloud.io/dashboard?id=rijksmuseum-typescript-api) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=rijksmuseum-typescript-api&metric=security_rating)](https://sonarcloud.io/dashboard?id=rijksmuseum-typescript-api)

## Install

```bash
npm i rijksmuseum-typescript-api
```

## Usage

```typescript
let api: RijksmuseumClient = new RijksmuseumClient('<API_KEY>');

// Get a artwork by it's ID:

api.artwork.getById('SK-C-1454').subscribe(artwork => {  
    console.log(`"${artwork.title}" was created by ${artwork.principalMaker}`);
});

// Search for artworks by criteria:
const criteria = new SearchCriteria();
criteria.page = 1;
criteria.page_result_count = 25;
criteria.type = "painting";

api.artwork.search().subscribe(searchResults => {  
    console.log(`A total of ${searchResults.total_results} artworks has been found`);
});
```