PaperService

Call

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

PLAPI.paperService.methodname(...);

Avaliable Methods

load

/**
 * Load paper entities with filter and sort.
 * @param querySentence - Query sentence, string or PaperFilterOptions
 * @param sortBy - Sort by
 * @param sortOrder - Sort order
 * @returns Paper entities
 */
load(querySentence: string, sortBy: string | undefined, sortOrder: "asce" | "desc", fulltextQuerySentence?: string): Promise<IPaperEntityCollection>;

loadByIds

/**
 * Load paper entities by IDs.
 * @param ids - Paper entity ids
 * @returns Paper entities
 */
loadByIds(ids: OID[]): Promise<never[] | Realm.Results<PaperEntity & Realm.Object<unknown, never>>>;

update

/**
 * Update paper entities.
 * @param paperEntityDrafts - paper entity drafts
 * @param updateCache - Update cache, default is true
 * @param isUpdate - Is update, default is false, if false, it is insert. This is for preventing insert duplicated papers.
 * @returns Updated paper entities
 */
update(paperEntityDrafts: IPaperEntityCollection, updateCache?: boolean, isUpdate?: boolean): Promise<IPaperEntityCollection>;

updateWithCategorizer

/**
 * Update paper entities with a categorizer.
 * @param ids - The list of paper IDs.
 * @param categorizer - The categorizer.
 * @param type - The type of the categorizer.
 */
updateWithCategorizer(ids: OID[], categorizer: Categorizer, type: CategorizerType): Promise<void>;

updateMainURL

/**
 * Update the main file of a paper entity.
 * @param paperEntity - The paper entity.
 * @param url - The URL of the main file.
 * @returns The updated paper entity.
 */
updateMainURL(paperEntity: PaperEntity, url: string): Promise<PaperEntity | undefined>;

updateSupURLs

/**
 * Update the supplementary files of a paper entity.
 * @param paperEntity - The paper entity.
 * @param urls - The URLs of the supplementary files.
 */
updateSupURLs(paperEntity: PaperEntity, urls: string[]): Promise<void>;

delete

/**
 * Delete paper entities.
 * @param ids - Paper entity ids
 * @param paperEntity - Paper entities
 */
delete(ids?: OID[], paperEntities?: PaperEntity[]): Promise<void>;

deleteSup

/**
 * Delete a suplementary file.
 * @param paperEntity - The paper entity.
 * @param url - The URL of the supplementary file.
 */
deleteSup(paperEntity: PaperEntity, url: string): Promise<void>;

create

/**
    * Create paper entity from file URLs.
    * @param urlList - The list of URLs.
    * @returns The list of paper entity drafts.
    */
create(urlList: string[]): Promise<IPaperEntityCollection>;

createIntoCategorizer

/**
 * Create paper entity from a URL with a given categorizer.
 * @param urlList - The list of URLs.
 * @param categorizer - The categorizer.
 * @param type - The type of categorizer.
 * @returns The list of paper entity drafts.
 */
createIntoCategorizer(urlList: string[], categorizer: Categorizer, type: CategorizerType): Promise<IPaperEntityCollection>;

scrape

/**
 * Scrape paper entities.
 * @param paperEntities - The list of paper entities.
 * @param specificScrapers - The list of specific scrapers.
 */
scrape(paperEntities: IPaperEntityCollection, specificScrapers?: string[]): Promise<void>;

scrapePreprint

/**
 * Scrape preprint paper entities.
 */
scrapePreprint(): Promise<void>;

renameAll

/**
 * Rename all paper entities.
 */
renameAll(): Promise<void>;

Events

Event ID	Callback Value	Description
updated	{key: 'updated'}	When PaperEntity database is updated
count	`{key: 'count', value: count	When FeedEntity database count is changed