# @chumsinc/gtin-tools

> GTIN Tools for CHUMS

Latest version **1.0.3** (published 2023-02-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install @chumsinc/gtin-tools
pnpm add @chumsinc/gtin-tools
yarn add @chumsinc/gtin-tools
bun add @chumsinc/gtin-tools
```

## Health

**Score 30/100 (F)** — status: abandoned.

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2023-02-01 |
| First published | 2023-02-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Steve Montgomery |
| Maintainers | utahgooner |
| Keywords | GTIN-12, UPC, barcode |

## Links

- npm: https://www.npmjs.com/package/@chumsinc/gtin-tools
- Repository: https://github.com/UtahGooner/gtin-tools
- Homepage: https://github.com/UtahGooner/gtin-tools#readme
- Issues: https://github.com/UtahGooner/gtin-tools/issues
- npm.io page: https://npm.io/package/@chumsinc/gtin-tools

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2023-02-01
- 1.0.2 — 2023-02-01
- 1.0.1 — 2023-02-01

## README

![Chums Logo](https://intranet.chums.com/images/chums/chums-badge-120x120.png)
# GTIN Tools

## Installation
    npm install @chumsinc/gtin-tools

## Usage & Examples

```typescript
import {
    couldBeGTIN, 
    trimUPC, 
    parseCheckDigit, 
    parseUPCA, 
    parseGTINFormat,
    formatGTIN
} from "@chumsinc/gtin-tools";

couldBeGTIN('ASD123') //returns false
couldBeGTIN('01234567890') //returns true
couldBeGTIN('0 12345 67890') //returns true
couldBeGTIN('0 12345 67890 5') //returns true
couldBeGTIN('0 12345 67890 X') //returns false

trimUPC('0 12345 67890 5') // returns '012345678905'
parseCheckDigit('01234567890', 'GTIN-12') // returns '5'

parseGTINFormat('01234567890') // returns 'GTIN-12', gtin-12 without check digit
parseGTINFormat('012345678905') // returns 'GTIN-12'
parseGTINFormat('451234567890') // returns 'GTIN-13' Japan GTIN-13 without check digit

formatGTIN('01234567890') // returns '0 12345 67890 5', corrects check digit & adds spaces 
formatGTIN('012345678908') // returns '0 12345 67890 5', corrects check digit & adds spaces 
formatGTIN('012345678908', true) // returns '012345678905', corrects check digit 

```

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