# @types/hex-array

> TypeScript definitions for hex-array

Latest version **1.0.2** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/hex-array
pnpm add @types/hex-array
yarn add @types/hex-array
bun add @types/hex-array
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2023-11-07 |
| First published | 2022-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51448 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/hex-array
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hex-array
- npm.io page: https://npm.io/package/@types/hex-array

## Recent versions

- 1.0.2 (latest) — 2023-11-07
- 1.0.0 (ts4.1) — 2022-11-03
- 1.0.1 — 2023-10-18

## README

# Installation
> `npm install --save @types/hex-array`

# Summary
This package contains type definitions for hex-array (https://github.com/colinbarry/hex-array#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hex-array.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hex-array/index.d.ts)
````ts
export interface Options {
    /**
     * This number of hex bytes are grouped together with spaces between groups.
     * 0 means no grouping is applied. 0 if unspecified.
     */
    grouping?: number;

    /**
     * The number of groups which make up a row. When 0, no splitting into rows
     * occurs. 0 if unspecified.
     */
    rowlength?: number;

    /**
     * If true, the output will be in uppercase. true by default.
     */
    uppercase: boolean;
}

/**
 * Takes a string containing hexadecimal and returns the equivalent as a
 * Uint8Array buffer.
 *
 * @param string The string to convert. Whitespace is ignored. If an odd number
 * of characters are specified, it will act as if preceeded with a leading 0;
 * that is, "FFF" is equivalent to "0FFF".
 *
 * @returns a Uint8Array array.
 */
export function fromString(string: string): Uint8Array;

/**
 * Converts the given buffer to a string containing its hexadecimal
 * representation.
 *
 * @param array a Uint8Array buffer to convert
 * @param [options] an optional object
 *
 * @returns a hexadecimal string representing the buffer.
 */
export function toString(array: Uint8Array, options?: Options): string;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: none

# Credits
These definitions were written by [0xcaff](https://github.com/0xcaff).

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