1.0.8 • Published 1 year ago

paper-fetch v1.0.8

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

paper-fetch

paper-fetch is a library to search for papers and fetch information about a paper from open-access APIs.

Installation

yarn add paper-fetch
// or
npm install paper-fetch

Usage

Fetching a paper

import {fetchPaper, PaperQuery} from 'paper-fetch';
const paperQuery: PaperQuery = {
  semanticScholarId: '2c03df8b48bf3fa39054345bafabfeff15bfd11d'
};
const paper = fetchPaper(
    paperQuery, 
    ['arxiv', 'semanticScholar', 'crossRef', 'openReview']).then(
      (p) => console.log(p));

// Logs: {
//   title: 'Deep Residual Learning for Image Recognition',
//   ...
// }

Searching for papers

import {searchPapers, PaperQuery} from 'paper-fetch';
const papers = searchPapers(
    'Deep Residual Learning for Image Recognition',
    ['arxiv', 'semanticScholar']).then(
      (ps) => console.log(ps));
// Logs: [
//   {
//     title: 'Deep Residual Learning for Image Recognition',
//     ...
//   },
//   ...
// ]

Returned Fields

paper-fetch returns a Paper object with the following fields:

FieldTypeDescription
titlestringThe title of the paper.
authorsAuthor[]The authors of the paper.
abstractstringThe abstract of the paper.
pdfUrlstringThe URL of the PDF of the paper.
idsRecord<string, string>The IDs of the paper.
venuestringThe venue of the paper.
yearnumberThe year of the paper.
numCitationsnumberThe number of citations of the paper.
numReferencesnumberThe number of references of the paper.
tldrstringThe TL;DR of the paper.
affliationsstring[]The affliations of the authors.
autoTagsstring[]The auto tags of the paper.
sourcesRecord<SourceKey, SourcePaper>Data returned by each source.
urlsUrl[]List of URLs related to the paper.
1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.1

1 year ago