ReferenceService

Call

import { PLAPI } from "paperlib-api/api";

PLAPI.referenceService.methodname(...);

Avaliable Methods

replacePublication

/**
 * Abbreviate the publication name according to the abbreviation list set in the preference interface.
 * @param source - The source paper entity.
 * @returns The paper entity with publication name abbreviated.
 */
replacePublication(source: PaperEntity): PaperEntity;

toCite

/**
 * Convert paper entity to citationjs object.
 * @param source - The source paper entity.
 * @returns The cite object.
 */
toCite(source: PaperEntity | PaperEntity[] | string): any;

exportBibTexKey

/**
 * Export BibTex key.
 * @param paperEntities - The paper entities.
 * @returns The BibTex key.
 */
exportBibTexKey(paperEntities: PaperEntity[]): string;

exportBibTexBody

/**
 * Export BibTex body string.
 * @param paperEntities - The paper entities.
 * @returns The BibTex body string.
 */
exportBibTexBody(paperEntities: PaperEntity[]): string;

exportBibTex

/**
 * Export plain text.
 * @param paperEntities - The paper entities.
 * @returns The plain text.
 */
exportPlainText(paperEntities: PaperEntity[]): Promise<string>;

exportCSV

/**
 * Export papers as csv string.
 * @param paperEntities - The paper entities.
 * @returns The CSV string.
 */
exportCSV(paperEntities: PaperEntity[]): Promise<string>;

exportBibTexKeyInFolder

/**
 * Export BibTex body string in folder.
 * @param folderName - The folder name.
 */
exportBibTexBodyInFolder(folderName: string): Promise<string>;

exportBibTexBodyInFolder

/**
 * Export plain text in folder.
 * @param folderName - The folder name.
 */
exportPlainTextInFolder(folderName: string): Promise<string>;

exportBibItem

/**
 * Export BibItem.
 * @param paperEntities - The paper entities.
 * @returns The BibItem.
 */
exportBibItem(paperEntities: PaperEntity[]): Promise<string>;

export

/**
 * Export paper entities.
 * @param paperEntities - The paper entities.
 * @param format - The export format: "BibTex" | "BibTex-Key" | "PlainText"
 */
export(paperEntities: PaperEntity[], format: string): Promise<void>;