@adisuper94/orcid/esm/index.d.ts

ORCID API client

import { type AffiliationGroup, type Education, type Employment } from "./types.js";
/**
 * @module
 * This module provides functions to fetch `Education` and `Employment` details of an ORCID ID from
 * ORCID's public API.
 */
/**
 * Fetches `Employment` details of `orcidId` from orcid's public API
 *
 * @example
 * ```typescript
 * const orcidId = "0000-0000-0000-0000";
 * const [edu, err] = await getEmployment(orcidId);
 * if (err){
 * //handle err
 * }
 *
 * ```
 *
 * @param orcidId
 * @returns tuple containing `Education` summary array and `Error`
 */
export declare function getEmployment(orcidId: string): Promise<[Employment[], undefined] | [undefined, Error]>;
/**
 * Fetches `Education` details of `orcidId` from orcid's public API
 *
 * @example
 * ```typescript
 * const orcidId = "0000-0000-0000-0000";
 * const [edu, err] = await getEducation(orcidId);
 * if (err){
 * //handle err
 * }
 *
 * ```
 *
 * @param orcidId
 * @returns tuple containing `Education` summary array and `Error`
 */
export declare function getEducation(orcidId: string): Promise<[Education[], undefined] | [undefined, Error]>;
export type { AffiliationGroup, Education, Employment };
//# sourceMappingURL=index.d.ts.map