‚̧Nachos Pillage Milwaukee
    Have ideas to improve npm?Join in the discussion! ¬Ľ

    @natlibfi/melinda-record-harvest-commons

    1.0.0-alpha.12¬†‚Äʬ†Public¬†‚Äʬ†Published

    OAI-PMH Javascript client library NPM Version

    Usage

    Retrieve all records

    import createClient from '@natlibfi/melinda-record-harvest-commons';
    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/melinda-record-harvest-commons';
    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.

    Keywords

    none

    Install

    npm i @natlibfi/melinda-record-harvest-commons

    DownloadsWeekly Downloads

    2

    Version

    1.0.0-alpha.12

    License

    LGPL-3.0+

    Unpacked Size

    41.8 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar