diff --git a/classes/OaiPmh.html b/classes/OaiPmh.html index 05a089b..1290d84 100644 --- a/classes/OaiPmh.html +++ b/classes/OaiPmh.html @@ -1,5 +1,5 @@ OaiPmh | @nondef/ts-oai-pmh

Class OaiPmh

Implements

IOAIHarvesterInterface

-

Implements

  • IOAIHarvesterInterface

Constructors

constructor +

Implements

  • IOAIHarvesterInterface

Constructors

constructor

Properties

baseUrl options

Methods

getRecord @@ -10,17 +10,17 @@ listSets request setBaseUrl -

Constructors

constructor

Properties

baseUrl

baseUrl: URL

options

options: IOAIHarvesterOptionsInterface

Methods

getRecord

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

  • retrieve an individual metadata record from a repository +

Constructors

constructor

Properties

baseUrl

baseUrl: URL

options

options: IOAIHarvesterOptionsInterface

Methods

getRecord

identify

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

  • retrieve information about a repository +

    Parameters

    • params: IOAIGetRecordRequestParamsInterface

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

identify

  • identify(): Promise<{
        adminEmail: {
            _: string;
        }[];
        baseURL: {
            _: string;
        }[];
        compression?: {
            _: string;
        }[];
        deletedRecord: {
            _: "no" | "persistent" | "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: {
            _: "no" | "persistent" | "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 +

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

listIdentifiers

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 +

    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

listSets

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

  • retrieve the set structure of a repository +

    Parameters

    • params: IOAIListRecordsRequestParamsInterface

    Returns AsyncGenerator<any, void, unknown>

listSets

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns AsyncGenerator<any, void, unknown>

request

setBaseUrl

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file