Class OaiPmh

constructor

• new OaiPmh(baseUrl, _options?): OaiPmh

• Parameters

  • baseUrl: URL

  • _options: {} = {}

  Returns OaiPmh

baseUrl

options

getRecord

• getRecord(params): Promise<{
      record: {}[];
  }[]>

• retrieve an individual metadata record from a repository https://www.openarchives.org/OAI/openarchivesprotocol.html#GetRecord

  Parameters

  • params: IOAIGetRecordRequestParamsInterface

  Returns Promise<{
      record: {}[];
  }[]>

identify

• identify(): Promise<{
      adminEmail: {
          _: string;
      }[];
      baseURL: {
          _: string;
      }[];
      compression?: {
          _: string;
      }[];
      deletedRecord: {
          _: "persistent" | "no" | "transient";
      }[];
      description: any[];
      earliestDatestamp: {
          _: string;
      }[];
      granularity: {
          _: "YYYY-MM-DD" | "YYYY-MM-DDThh:mm:ssZ";
      }[];
      protocolVersion: {
          _: string;
      }[];
      repositoryName: {
          _: string;
      }[];
  }[]>

• retrieve information about a repository https://www.openarchives.org/OAI/openarchivesprotocol.html#Identify

  Returns Promise<{
      adminEmail: {
          _: string;
      }[];
      baseURL: {
          _: string;
      }[];
      compression?: {
          _: string;
      }[];
      deletedRecord: {
          _: "persistent" | "no" | "transient";
      }[];
      description: any[];
      earliestDatestamp: {
          _: string;
      }[];
      granularity: {
          _: "YYYY-MM-DD" | "YYYY-MM-DDThh:mm:ssZ";
      }[];
      protocolVersion: {
          _: string;
      }[];
      repositoryName: {
          _: string;
      }[];
  }[]>

listIdentifiers

• listIdentifiers(params): AsyncGenerator<any, void, unknown>

• an abbreviated form of ListRecords, retrieving only headers rather than records https://www.openarchives.org/OAI/openarchivesprotocol.html#ListIdentifiers

  Parameters

  • params: IOAIListIdentifiersRequestParamsInterface

  Returns AsyncGenerator<any, void, unknown>

listMetadataFormats

• listMetadataFormats(params): Promise<{
      metadataFormat: {
          metadataNamespace: {
              _: string;
          }[];
          metadataPrefix: {
              _: string;
          }[];
          schema: {
              _: string;
          }[];
      }[];
  }[]>

• retrieve the metadata formats available from a repository for a specific record

  Parameters

  • params: IOAIListMetadataFormatsRequestParamsInterface

  Returns Promise<{
      metadataFormat: {
          metadataNamespace: {
              _: string;
          }[];
          metadataPrefix: {
              _: string;
          }[];
          schema: {
              _: string;
          }[];
      }[];
  }[]>

listRecords

• listRecords(params): AsyncGenerator<any, void, unknown>

• harvest records from a repository https://www.openarchives.org/OAI/openarchivesprotocol.html#ListRecords

  Parameters

  • params: IOAIListRecordsRequestParamsInterface

  Returns AsyncGenerator<any, void, unknown>

listSets

• listSets(): AsyncGenerator<any, void, unknown>

• retrieve the set structure of a repository https://www.openarchives.org/OAI/openarchivesprotocol.html#ListSets

  Returns AsyncGenerator<any, void, unknown>

request

• request(requestConfig, verb, params): Promise<AxiosResponse<string, string>>

• creates an HTTP request to the OAI-PMH endpoint

  Parameters

  • requestConfig: AxiosRequestConfig<any>

  • verb: "GetRecord" | "ListMetadataFormats" | "Identify" | "ListSets" | "ListIdentifiers" | "ListRecords"

  • params: Record<string, undefined | string>

  Returns Promise<AxiosResponse<string, string>>

setBaseUrl

• setBaseUrl(url): void

• sets the baseUrl of the OAI-PMH Endpoint to be used

  Parameters

  • url: URL

  Returns void