Class OaiPmh

constructor

• new OaiPmh(options: IOAIHarvesterConstructorOptionsInterface): OaiPmh

  Parameters

  • options: IOAIHarvesterConstructorOptionsInterface

  Returns OaiPmh

baseUrl

options

getRecord

• getRecord(
      params: IOAIGetRecordRequestParamsInterface,
  ): Promise<TOAIGetRecordsResponse>

  Parameters

  • params: IOAIGetRecordRequestParamsInterface

  Returns Promise<TOAIGetRecordsResponse>

identify

• identify(params?: Record<string, never>): Promise<TOAIIdentifyResponse>

  Parameters

  • params: Record<string, never> = {}

  Returns Promise<TOAIIdentifyResponse>

listIdentifiers

• listIdentifiers(
      params: IOAIListIdentifiersRequestParamsInterface,
  ): AsyncGenerator<TOAIHeader>

  Parameters

  • params: IOAIListIdentifiersRequestParamsInterface

  Returns AsyncGenerator<TOAIHeader>

listMetadataFormats

• listMetadataFormats(
      params?: IOAIListMetadataFormatsRequestParamsInterface,
  ): Promise<TOAIListMetadataFormatsResponse>

  Parameters

  • params: IOAIListMetadataFormatsRequestParamsInterface = {}

  Returns Promise<TOAIListMetadataFormatsResponse>

listRecords

• listRecords(
      params: IOAIListRecordsRequestParamsInterface,
  ): AsyncGenerator<TOAIRecord>

  Parameters

  • params: IOAIListRecordsRequestParamsInterface

  Returns AsyncGenerator<TOAIRecord>

listSets

• listSets(params?: IOAIListRequestParamsInterface): AsyncGenerator<TOAISet>

  Parameters

  • params: IOAIListRequestParamsInterface = {}

  Returns AsyncGenerator<TOAISet>

request

• request(
      verb:
          | "GetRecord"
          | "Identify"
          | "ListMetadataFormats"
          | "ListIdentifiers"
          | "ListRecords"
          | "ListSets",
      params?: TOAIRequestParams,
  ): Promise<string>

  Parameters

  • verb:
        | "GetRecord"
        | "Identify"
        | "ListMetadataFormats"
        | "ListIdentifiers"
        | "ListRecords"
        | "ListSets"
  • params: TOAIRequestParams = {}

  Returns Promise<string>

setBaseUrl

• setBaseUrl(url: string | URL): void

  Parameters

  • url: string | URL

  Returns void