# @speleotica/frcs2breakout

> convert frcs cave survey data to breakout format

Latest version **2.1.0** (published 2026-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @speleotica/frcs2breakout
pnpm add @speleotica/frcs2breakout
yarn add @speleotica/frcs2breakout
bun add @speleotica/frcs2breakout
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2026-04-22 |
| First published | 2021-11-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16 |
| Dependencies | 3 |
| Unpacked size | 65.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Andy Edwards |
| Maintainers | jedwards1211 |
| Keywords | cave-survey |

## Links

- npm: https://www.npmjs.com/package/@speleotica/frcs2breakout
- Repository: https://github.com/speleotica/frcs2breakout
- Homepage: https://github.com/speleotica/frcs2breakout#readme
- Issues: https://github.com/speleotica/frcs2breakout/issues
- npm.io page: https://npm.io/package/@speleotica/frcs2breakout

## Dependencies (3)

- [parse-segment](https://npm.io/package/parse-segment.md) ^1.5.3
- [@speleotica/frcsdata](https://npm.io/package/@speleotica/frcsdata.md) ^5.0.0
- [@speleotica/unitized](https://npm.io/package/@speleotica/unitized.md) ^2.0.0

## Recent versions

- 2.1.0 (latest) — 2026-04-22
- 1.2.0-beta.3 (beta) — 2026-04-21
- 2.0.0 — 2026-03-16
- 1.2.0-beta.2 — 2026-03-07
- 1.2.0-beta.1 — 2026-03-07
- 1.1.2 — 2021-11-17
- 1.1.1 — 2021-11-17
- 1.1.0 — 2021-11-17
- 1.0.0 — 2021-11-17

## README

# @speleotica/frcs2breakout

[![CircleCI](https://circleci.com/gh/speleotica/frcs2breakout.svg?style=svg)](https://circleci.com/gh/speleotica/frcs2breakout)
[![Coverage Status](https://codecov.io/gh/speleotica/frcs2breakout/branch/master/graph/badge.svg)](https://codecov.io/gh/speleotica/frcs2breakout)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![npm version](https://badge.fury.io/js/%40speleotica%2Ffrcs2breakout.svg)](https://badge.fury.io/js/%40speleotica%2Ffrcs2breakout)

Converts data from [FRCS format](https://github.com/speleotica/frcsdata) to [Breakout](https://github.com/jedwards1211/breakout).

# API

```ts
import {
  FrcsPlotFile,
  FrcsSurveyFile,
  FrcsTripSummaryFile,
} from '@speleotica/frcsdata'
import { Length, UnitizedNumber } from '@speleotica/unitized'

type CaveInput = {
  /**
   * Parsed survey file data
   */
  survey: FrcsSurveyFile
  /**
   * Parsed plot file data
   */
  plot?: FrcsPlotFile
  /**
   * Parsed trip summaries file data
   */
  summaries?: FrcsTripSummaryFile
  /**
   * If given, will add survey notes filenames to the output trips
   */
  surveyNotesFilePrefix?: string
  /**
   * The UTM zone of the plot.  If omitted, fixed stations won't be output
   */
  utmZone?: number
  /**
   * Offset to apply to fixed stations from the plot
   */
  zeroReference?: {
    northing: UnitizedNumber<Length>
    easting: UnitizedNumber<Length>
    elevation: UnitizedNumber<Length>
  }
}

export function convertToBreakout(data: Record<string, CaveInput>): MetacaveData
```

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