orcid
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

orcid

orcid on npm MIT License CI

A utility and CLI to work with ORCID in your applications.

Install

npm install orcid

Using the Command Line

Use the search command to find an ORCID given an authors full name (in quotes). The query is powered by OpenAlex, and gives a publication hint, last known institution, and concepts that the author publishes about. The command only returns results for authors with ORCIDs.

orcid search "rowan cockett"

> Found 1 result for "rowan cockett" with an ORCID:

> Rowan Cockett
> 0000-0002-7859-8394
>   Hint: SimPEG: An open source framework for simulation ...
>   Last Institution: University of British Columbia
>   Concepts: Geology, Computer science, Engineering, Physics ...

Using Node

import { orcid } from 'orcid';

const isValid = orcid.validate('https://orcid.org/0000-0002-7859-8394');

orcid.buildUrl('http://orcid.org/0000-0002-7859-8394');
orcid.buildUrl('https://www.orcid.org/0000-0002-7859-8394');
orcid.buildUrl('0000-0002-7859-8394');
// These all point to https://orcid.org/0000-0002-7859-8394

Included Utilities

  • validate - Validates if a single ORCID string is valid
  • normalize - Normalizes an ORCID url or string into a ORCID identifier of the form 0000-0002-7859-8394
  • buildUrl - Builds a URL to https://orcid.org, includes normalization

Options

  • strict: only accept the ID part without the URL

As of v1.0.0 this package is ESM only.


Made with love by Curvenote

Readme

Keywords

Package Sidebar

Install

npm i orcid

Weekly Downloads

598

Version

1.0.0

License

MIT

Unpacked Size

424 kB

Total Files

12

Last publish

Collaborators

  • rowanc1
  • stevejpurves