# @speleotica/frcsdata

> parser for Chip Hopper's survey data format used in Fisher Ridge Cave System

Latest version **5.1.2** (published 2026-04-21) · MIT license · 0 weekly downloads

## Install

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

Provides the command `frcsdata`.

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 5.1.2 |
| Published | 2026-04-21 |
| First published | 2019-11-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16 |
| Dependencies | 11 |
| Unpacked size | 7.4 MB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Andy Edwards |
| Maintainers | jedwards1211 |
| Keywords | cave-survey |

## Links

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

## Dependencies (11)

- [zod](https://npm.io/package/zod.md) ^3
- [glob](https://npm.io/package/glob.md) ^13.0.6
- [yaml](https://npm.io/package/yaml.md) ^2.8.2
- [chalk](https://npm.io/package/chalk.md) ^4
- [yargs](https://npm.io/package/yargs.md) ^17
- [dedent-js](https://npm.io/package/dedent-js.md) ^1.0.1
- [windows-1252](https://npm.io/package/windows-1252.md) ^3.0.4
- [parse-segment](https://npm.io/package/parse-segment.md) ^1.5.4
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.18.6
- [@jcoreio/utils](https://npm.io/package/@jcoreio/utils.md) 0.0.0-development
- [@speleotica/unitized](https://npm.io/package/@speleotica/unitized.md) ^2.0.0

## Recent versions

- 5.1.2 (latest) — 2026-04-21
- 5.0.0-beta.5 (beta) — 2026-03-16
- 5.1.1 — 2026-03-24
- 5.1.0 — 2026-03-17
- 5.0.2 — 2026-03-17
- 5.0.1 — 2026-03-16
- 5.0.0 — 2026-03-16
- 5.0.0-beta.4 — 2026-03-10
- 5.0.0-beta.3 — 2026-03-09
- 5.0.0-beta.2 — 2026-03-09
- 5.0.0-beta.1 — 2026-03-07
- 4.3.1 — 2025-05-29
- 4.3.0 — 2024-08-26
- 4.2.0 — 2024-04-30
- 4.1.1 — 2024-04-30
- … 13 more at https://npm.io/package/@speleotica/frcsdata/versions

## README

# @speleotica/frcsdata

[![CircleCI](https://circleci.com/gh/speleotica/frcsdata.svg?style=svg)](https://circleci.com/gh/speleotica/frcsdata)
[![Coverage Status](https://codecov.io/gh/speleotica/frcsdata/branch/master/graph/badge.svg)](https://codecov.io/gh/speleotica/frcsdata)
[![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%2Ffrcsdata.svg)](https://badge.fury.io/js/%40speleotica%2Ffrcsdata)

Parser for Chip Hopper's survey data format used in Fisher Ridge Cave System

# Parse function variants

#### AsyncIterable: `parseFrcsXFile(file: string, lines: AsyncIterable<string>): Promise<FrcsXFile>`

These can be imported from the package root (`@speleotica/frcsdata`). The other variants wrap these.

#### String: `parseFrcsXFile(file: string, data: string): Promise<FrcsXFile>`

These can be imported from `@speleotica/frcsdata/string`.

#### Node: `parseFrcsXFile(file: string): Promise<FrcsXFile>`

These can be imported from `@speleotica/frcsdata/node` and read the given file from disk. They require Node >=12.

# File types

I'm not going to document this much right now but there are three types of files:

## Survey Files

These files typically look like `cdata.fr` where the extension is actually an abbrevation of the cave name.

```js
import { parseFrcsSurveyFile } from '@speleotica/frcsdata'
import { parseFrcsSurveyFile } from '@speleotica/frcsdata/node'
import { parseFrcsSurveyFile } from '@speleotica/frcsdata/string'
```

These functions return a `Promise` that resolves to an [`FrcsSurveyFile`](/src/FrcsSurveyFile.ts).

## Trip Summary Files

These files typically look like `STAT_sum.txt`.

```js
import { parseFrcsTripSummaryFile } from '@speleotica/frcsdata'
import { parseFrcsTripSummaryFile } from '@speleotica/frcsdata/node'
import { parseFrcsTripSummaryFile } from '@speleotica/frcsdata/string'
```

These functions return a `Promise` that resolves to an [`FrcsTripSummaryFile`](/src/FrcsTripSummaryFile.ts).

## Plot Files

These files typically look like `FOR008.fr` where the extension is actually an abbrevation of the cave name.

```js
import { parseFrcsPlotFile } from '@speleotica/frcsdata'
import { parseFrcsPlotFile } from '@speleotica/frcsdata/node'
import { parseFrcsPlotFile } from '@speleotica/frcsdata/string'
```

These functions return a `Promise` that resolves to an [`FrcsPlotFile`](/src/FrcsPlotFile.ts).

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