# orcid

> Utilities for working with ORCID identifiers and service.

Latest version **1.0.0** (published 2023-06-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install orcid
pnpm add orcid
yarn add orcid
bun add orcid
```

Provides the command `orcid`.

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-06-09 |
| First published | 2022-12-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 0 |
| Unpacked size | 413.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Rowan Cockett |
| Maintainers | rowanc1 |
| Keywords | Open Science, ORCID |

## Links

- npm: https://www.npmjs.com/package/orcid
- Repository: https://github.com/curvenote/orcid
- Issues: https://github.com/curvenote/orcid/issues
- npm.io page: https://npm.io/package/orcid

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-06-09
- 0.0.5 — 2023-01-01
- 0.0.4 — 2023-01-01
- 0.0.3 — 2023-01-01
- 0.0.2 — 2022-12-31
- 0.0.1 — 2022-12-23

## README

# orcid

[![orcid on npm](https://img.shields.io/npm/v/orcid.svg)](https://www.npmjs.com/package/orcid)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/curvenote/orcid/blob/main/LICENSE)
![CI](https://github.com/curvenote/orcid/workflows/CI/badge.svg)

A utility and CLI to work with [ORCID](https://orcid.org) in your applications.

## Install

```bash
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.

```bash
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

```ts
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](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).

---

<p style="text-align: center; color: #aaa; padding-top: 50px">
  Made with love by
  <a href="https://curvenote.com" target="_blank" style="color: #aaa">
    <img src="https://curvenote.dev/images/icon.png" style="height: 1em" /> Curvenote
  </a>
</p>

---
_Source: https://npm.io/package/orcid · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._