# @stemn/whats-that-gerber

> Guesses the PCB layer type given a filename of a Gerber or drill file

Latest version **2.1.2** (published 2018-07-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install @stemn/whats-that-gerber
pnpm add @stemn/whats-that-gerber
yarn add @stemn/whats-that-gerber
bun add @stemn/whats-that-gerber
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.2 |
| Published | 2018-07-02 |
| First published | 2018-07-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 17.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Maintainers | mrblenny, sabrehagen |
| Keywords | pcb, gerber, svg, gerber-to-svg, hardware, circuit |

## Links

- npm: https://www.npmjs.com/package/@stemn/whats-that-gerber
- Repository: https://github.com/tracespace/whats-that-gerber
- Homepage: https://github.com/tracespace/whats-that-gerber#readme
- Issues: https://github.com/tracespace/whats-that-gerber/issues
- npm.io page: https://npm.io/package/@stemn/whats-that-gerber

## 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

- 2.1.2 (latest) — 2018-07-02
- 2.1.1 — 2018-07-02

## README

# what's that gerber?

[![GitHub issues](https://img.shields.io/github/issues/tracespace/whats-that-gerber.svg?style=flat-square&maxAge=86400)](https://github.com/tracespace/whats-that-gerber/issues)
[![npm](https://img.shields.io/npm/v/whats-that-gerber.svg?style=flat-square&maxAge=86400)](https://www.npmjs.com/package/whats-that-gerber)
[![Travis](https://img.shields.io/travis/tracespace/whats-that-gerber/master.svg?style=flat-square&maxAge=86400)](https://travis-ci.org/tracespace/whats-that-gerber)
[![David](https://img.shields.io/david/tracespace/whats-that-gerber.svg?style=flat-square&maxAge=86400)](https://david-dm.org/tracespace/whats-that-gerber)
[![David devDependencies](https://img.shields.io/david/dev/tracespace/whats-that-gerber.svg?style=flat-square&maxAge=86400)](https://david-dm.org/tracespace/whats-that-gerber?type=dev)

Identify the probable PCB layer type of a Gerber or drill file by its filename.

## usage

``` javascript
var whatsThatGerber = require('whats-that-gerber')

var filename = 'my-board-F_Cu.gbr'
var layerType = whatsThatGerber(filename)              // 'tcu'
var layerName = whatsThatGerber.getFullName(layerType) // 'top copper'
```

### layer types and names

There are 12 available layer types. You can get an array of all types with:

``` javascript
var whatsThatGerber = require('whats-that-gerber')
var allLayerTypes = whatsThatGerber.getAllTypes() // ['drw', 'tcu', ...]
```

type | full name (en)     
-----|--------------------
drw  | gerber drawing     
tcu  | top copper         
tsm  | top soldermask     
tss  | top silkscreen     
tsp  | top solderpaste    
bcu  | bottom copper      
bsm  | bottom soldermask  
bss  | bottom silkscreen  
bsp  | bottom solderpaste
icu  | inner copper       
out  | board outline      
drl  | drill hits         

#### checking if a layer type is valid

You can check if any given string is a valid layer type with:

``` js
var whatsThatGerber = require('whats-that-gerber')
var isValidType = whatsThatGerber.isValidType

var type1 = 'tsm'
var type2 = 'hello'

console.log(isValidType(type1)) // true
console.log(isValidType(type2)) // false
```

### full name locales

The full name method takes a locale string as its second parameter, which defaults to 'en':

``` javascript
var fullName = whatsThatGerber.getFullName('tcu', 'en')
```

Currently, no other locales are supported (because I don't know any!); contributions are greatly appreciated. If the type or locale is unrecognized, the result will be an empty string. Locale additions will be considered patch-level upgrades.

### supported cad programs

We should be able to identify files output by the following programs:

* KiCad
* Eagle
* Altium
* Orcad
* gEDA PCB

## contributing

1. `$ git clone tracespace/whats-that-gerber`
2. `$ npm install`
3. `$ npm test`

If adding / modifying a filetype matcher, please remember to add / modify an example filename in [test/filenames-by-cad.json](test/filenames-by-cad.json).

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