Giter VIP home page Giter VIP logo

oai-pmh-client-js's Introduction

OAI-PMH Javascript client library NPM Version

Usage

Retrieve all records

import createClient from '@natlibfi/oai-pmh-client';
const client = createClient({url: 'https://foo.bar', metadataPrefix: 'marc'});

client.listRecords()
  .on('record', record => processRecord(string))
  .on('end', () => endProcessing())
  .on('error', err => handleError(err));

Retrieve records only from the first response

import createClient from '@natlibfi/oai-pmh-client';
const client = createClient({url: 'https://foo.bar', metadataPrefix: 'marc', retrieveAll: false});

client.listRecords()
  .on('record', record => processRecord(string))
  .on('end', resumptionToken => endProcessing(resumptionToken))
  .on('error', err => handleError(err));

And then use the returned resumption token:

client.listRecords({resumptionToken})
  .on('record', record => processRecord(string))
  .on('end', resumptionToken => endProcessing(resumptionToken))
  .on('error', err => handleError(err));

Configuration

Client creation options

  • url: The URL of the OAI-PMH service.
  • metadataPrefix: Metadata prefix to use. Mandatory.
  • set: Set to use.
  • metadataFormat: Format of the metadata argument in record event. Defaults to string (See export metadataFormats)
  • retrieveAll: Whether to retrieve all records or just from the first response. If false, the end event returns the resumptionToken.
  • filterDeleted: Whether to filter out deleted records. Defaults to false.

listRecords options:

  • metadataPrefix: Override default metadata prefix.
  • set: Override default set.
  • resumptionToken: Resumption to use to resume the harvesting from.

License and copyright

Copyright (c) 2020 University Of Helsinki (The National Library Of Finland)

This project's source code is licensed under the terms of GNU Lesser General Public License Version 3 or any later version.

oai-pmh-client-js's People

Contributors

natlibfi-arlehiko avatar natlibfi-melinda-automation avatar

Watchers

James Cloos 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.