# chs

> Cylinder-Head-Sector Address (CHS)

Latest version **1.1.0** (published 2017-06-21) · MIT license · 0 weekly downloads

## Install

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

## 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 | 1.1.0 |
| Published | 2017-06-21 |
| First published | 2014-01-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jonas Hermsmeier |
| Maintainers | jhermsmeier |
| Keywords | chs, address, cylinder, head, sector, mbr, lba, block, hdd, gpt, disk |

## Links

- npm: https://www.npmjs.com/package/chs
- Repository: https://github.com/jhermsmeier/node-chs
- Issues: https://github.com/jhermsmeier/node-chs/issues
- npm.io page: https://npm.io/package/chs

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2017-06-21
- 1.0.1 — 2017-06-16
- 1.0.0 — 2016-10-04
- 0.4.0 — 2016-07-14
- 0.3.0 — 2016-07-14
- 0.2.1 — 2015-05-10
- 0.2.0 — 2015-04-16
- 0.1.0 — 2014-01-06

## README

# CHS (Cylinder-Head-Sector) Address
[![npm](https://img.shields.io/npm/v/chs.svg?style=flat-square)](https://npmjs.com/package/chs)
[![npm license](https://img.shields.io/npm/l/chs.svg?style=flat-square)](https://npmjs.com/package/chs)
[![npm downloads](https://img.shields.io/npm/dm/chs.svg?style=flat-square)](https://npmjs.com/package/chs)
[![build status](https://img.shields.io/travis/jhermsmeier/node-chs.svg?style=flat-square)](https://travis-ci.org/jhermsmeier/node-chs)

[CHS addressing] is an early method for giving addresses to each physical block of data on a hard disk drive,
identifying individual sectors on a disk by their position in a track, where the track is determined by the head and cylinder numbers.

[CHS addressing]: https://en.wikipedia.org/wiki/Cylinder-head-sector

# Install via [npm](https://npmjs.com)

```sh
$ npm install --save chs
```

# Usage

```js
// Load module
var CHS = require( 'chs' )
```
```js
// Create a CHS address
var addr = new CHS( 5, 20, 8 )
```
```js
// Properties:
var c = addr.cylinder
var h = addr.head
var s = addr.sector
```
```js
// Convert to an LBA (Logical Block Address)
var lba = addr.toLBA( headsPerTrack, sectorsPerTrack )
var lba = addr.toLBA( 12, 32 )
```
```js
// Set it to an LBA
addr.setLBA( lba, headsPerTrack, sectorsPerTrack )
addr.setLBA( 3150, 16, 63 )
```
```js
// Get it as a buffer
var buf = addr.buffer
var buf = addr.toBuffer()
```
```js
// Set from buffer
addr.buffer = new Buffer([ 0xFE, 0xFF, 0xFF ])
addr.parse( new Buffer([ 0xFE, 0xFF, 0xFF ]) )
```

# API Reference
<a name="CHS"></a>

## CHS
**Kind**: global class  

* [CHS](#CHS)
    * [new CHS([cylinder], [head], [sector])](#new_CHS_new)
    * _instance_
        * [.cylinder](#CHS+cylinder) : <code>Number</code>
        * [.head](#CHS+head) : <code>Number</code>
        * [.sector](#CHS+sector) : <code>Number</code>
        * [.buffer](#CHS+buffer) : <code>Buffer</code>
        * [.setLBA(lba, hpt, spt)](#CHS+setLBA) ⇒ [<code>CHS</code>](#CHS)
        * [.getLBA(hpt, spt)](#CHS+getLBA) ⇒ <code>Number</code>
        * [.toLBA(hpt, spt)](#CHS+toLBA) ⇒ <code>Number</code>
        * [.clone()](#CHS+clone) ⇒ [<code>CHS</code>](#CHS)
        * [.copy(target)](#CHS+copy) ⇒ [<code>CHS</code>](#CHS)
        * [.parse(buffer, [offset])](#CHS+parse) ⇒ [<code>CHS</code>](#CHS)
        * [.write(buffer, [offset])](#CHS+write) ⇒ <code>Buffer</code>
        * [.toBuffer()](#CHS+toBuffer) ⇒ <code>Buffer</code>
        * [.fromNumber(value)](#CHS+fromNumber) ⇒ [<code>CHS</code>](#CHS)
        * [.toNumber()](#CHS+toNumber) ⇒ <code>Number</code>
    * _static_
        * [.fromBuffer(buffer, [offset])](#CHS.fromBuffer) ⇒ [<code>CHS</code>](#CHS)
        * [.fromLBA(lba, hpt, spt)](#CHS.fromLBA) ⇒ [<code>CHS</code>](#CHS)


* * *

<a name="new_CHS_new"></a>

### new CHS([cylinder], [head], [sector])
Cylinder-Head-Sector Address

**Params**

- [cylinder] <code>Number</code> | <code>Buffer</code> <code> = 1023</code>
- [head] <code>Number</code> <code> = 254</code>
- [sector] <code>Number</code> <code> = 63</code>


* * *

<a name="CHS+cylinder"></a>

### chS.cylinder : <code>Number</code>
Cylinder

**Kind**: instance property of [<code>CHS</code>](#CHS)  

* * *

<a name="CHS+head"></a>

### chS.head : <code>Number</code>
Head

**Kind**: instance property of [<code>CHS</code>](#CHS)  

* * *

<a name="CHS+sector"></a>

### chS.sector : <code>Number</code>
Sector

**Kind**: instance property of [<code>CHS</code>](#CHS)  

* * *

<a name="CHS+buffer"></a>

### chS.buffer : <code>Buffer</code>
Get/set values from/to a Buffer

**Kind**: instance property of [<code>CHS</code>](#CHS)  

* * *

<a name="CHS+setLBA"></a>

### chS.setLBA(lba, hpt, spt) ⇒ [<code>CHS</code>](#CHS)
Set CHS to a Logical Block Address (LBA)

**Kind**: instance method of [<code>CHS</code>](#CHS)  
**Params**

- lba <code>Number</code> - Logical Block Address
- hpt <code>Number</code> - Heads per Track
- spt <code>Number</code> - Sectors per Track


* * *

<a name="CHS+getLBA"></a>

### chS.getLBA(hpt, spt) ⇒ <code>Number</code>
Get the Logical Block Address (LBA)
corresponding to the given disk geometry

**Kind**: instance method of [<code>CHS</code>](#CHS)  
**Returns**: <code>Number</code> - lba  
**Params**

- hpt <code>Number</code> - Heads per Track
- spt <code>Number</code> - Sectors per Track


* * *

<a name="CHS+toLBA"></a>

### chS.toLBA(hpt, spt) ⇒ <code>Number</code>
**Kind**: instance method of [<code>CHS</code>](#CHS)  
**Returns**: <code>Number</code> - lba  
**See**: #getLBA()  
**Params**

- hpt <code>Number</code> - Heads per Track
- spt <code>Number</code> - Sectors per Track


* * *

<a name="CHS+clone"></a>

### chS.clone() ⇒ [<code>CHS</code>](#CHS)
Clone the CHS Address

**Kind**: instance method of [<code>CHS</code>](#CHS)  

* * *

<a name="CHS+copy"></a>

### chS.copy(target) ⇒ [<code>CHS</code>](#CHS)
Copy this address to a target address

**Kind**: instance method of [<code>CHS</code>](#CHS)  
**Params**

- target [<code>CHS</code>](#CHS)


* * *

<a name="CHS+parse"></a>

### chS.parse(buffer, [offset]) ⇒ [<code>CHS</code>](#CHS)
Parse a given Buffer

**Kind**: instance method of [<code>CHS</code>](#CHS)  
**Params**

- buffer <code>Buffer</code>
- [offset] <code>Number</code> <code> = 0</code>


* * *

<a name="CHS+write"></a>

### chS.write(buffer, [offset]) ⇒ <code>Buffer</code>
Write the CHS address to a given buffer

**Kind**: instance method of [<code>CHS</code>](#CHS)  
**Params**

- buffer <code>Buffer</code>
- [offset] <code>Number</code> <code> = 0</code>


* * *

<a name="CHS+toBuffer"></a>

### chS.toBuffer() ⇒ <code>Buffer</code>
Create a Buffer representation of the CHS Address

**Kind**: instance method of [<code>CHS</code>](#CHS)  

* * *

<a name="CHS+fromNumber"></a>

### chS.fromNumber(value) ⇒ [<code>CHS</code>](#CHS)
Set the CHS address from its 24bit integer value

**Kind**: instance method of [<code>CHS</code>](#CHS)  
**Params**

- value <code>Number</code>


* * *

<a name="CHS+toNumber"></a>

### chS.toNumber() ⇒ <code>Number</code>
Get the 24bit integer value of the CHS address

**Kind**: instance method of [<code>CHS</code>](#CHS)  

* * *

<a name="CHS.fromBuffer"></a>

### CHS.fromBuffer(buffer, [offset]) ⇒ [<code>CHS</code>](#CHS)
Create a CHS Address from a given buffer

**Kind**: static method of [<code>CHS</code>](#CHS)  
**Params**

- buffer <code>Buffer</code>
- [offset] <code>Number</code> <code> = 0</code>


* * *

<a name="CHS.fromLBA"></a>

### CHS.fromLBA(lba, hpt, spt) ⇒ [<code>CHS</code>](#CHS)
Create a CHS Address from a Logical Block Address (LBA)

**Kind**: static method of [<code>CHS</code>](#CHS)  
**Params**

- lba <code>Number</code> - Logical Block Address
- hpt <code>Number</code> - Heads per Track
- spt <code>Number</code> - Sectors per Track


* * *

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