3.0.6 • Published 6 days ago
@natlibfi/oai-pmh-client v3.0.6
OAI-PMH Javascript client library
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, 2023-2024 University Of Helsinki (The National Library Of Finland)
This project's source code is licensed under the terms of MIT or any later version.
3.0.6
6 days ago
3.0.6-alpha.2
6 days ago
3.0.6-alpha.1
12 days ago
3.1.0-alpha.1
4 months ago
3.0.5
5 months ago
3.0.5-alpha.1
5 months ago
3.0.3
5 months ago
3.0.4-alpha.1
5 months ago
3.0.2-alpha.2
5 months ago
3.0.2
9 months ago
3.0.1
10 months ago
3.0.1-alpha.2
10 months ago
3.0.1-alpha.1
10 months ago
3.0.2-alpha.1
9 months ago
3.0.0-alpha.3
1 year ago
3.0.0-alpha.2
1 year ago
3.0.0-alpha.4
1 year ago
2.0.5
4 years ago
2.0.4
4 years ago
2.0.3
4 years ago
2.0.2
4 years ago
2.0.1
4 years ago
2.0.0
4 years ago
1.0.0
4 years ago
1.0.0-alpha.2
4 years ago
1.0.0-alpha.1
4 years ago