# @types/secret-box

> TypeScript definitions for secret-box

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

## Install

```sh
npm install @types/secret-box
pnpm add @types/secret-box
yarn add @types/secret-box
bun add @types/secret-box
```

## 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; pre 1.0.

Negative: abandoned.

## Facts

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

## Links

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

## Dependencies (2)

- [@types/node](https://npm.io/package/@types/node.md) *
- [@types/varstruct](https://npm.io/package/@types/varstruct.md) *

## Recent versions

- 0.1.4 (latest) — 2023-11-07
- 0.1.1 (ts4.1) — 2022-11-25
- 0.1.3 — 2023-10-18
- 0.1.2 — 2023-09-25
- 0.1.0 — 2022-11-07

## README

# Installation
> `npm install --save @types/secret-box`

# Summary
This package contains type definitions for secret-box (https://github.com/jprichardson/secret-box).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/secret-box.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/secret-box/index.d.ts)
````ts
/// <reference types="node" />

import { BinaryLike } from "node:crypto";
import { Codec } from "varstruct";

/**
 * Encrypt secrets. Built on AES-256-GCM and Scrypt.
 *
 * @example
 * import * as secretBox from 'secret-box'
 *
 * const passphrase = Buffer.from('open sesame 2')
 * const message = Buffer.from('The secret launch code is 1234.')
 *
 * const secret = secretBox.encrypt(message, passphrase)
 */
export function encrypt(message: Buffer, passphrase: string | Buffer, opts?: EncryptOptions): Buffer;
/**
 * Decrypt secrets. Built on AES-256-GCM and Scrypt.
 *
 * @example
 * import * as secretBox from 'secret-box'
 *
 * const passphrase = Buffer.from('open sesame 2')
 * const message = Buffer.from('The secret launch code is 1234.')
 *
 * const secret = secretBox.encrypt(message, passphrase)
 * const decrypted = secretBox.decrypt(secret, passphrase)
 *
 * console.log(decrypted.toString('utf8'))
 * // => The secret launch code is 1234.
 */
export function decrypt(secret: Buffer, passphrase: string | Buffer): Buffer;

export const struct: Codec<SerializedResult>;

export interface EncryptOptions {
    salt?: Buffer;
    iv?: BinaryLike;
    n?: number;
    r?: number;
    p?: number;
}

export interface SerializedResult {
    version: number;
    n: number;
    r: number;
    p: number;
    salt: Buffer;
    iv: Buffer;
    authTag: Buffer;
    secret: Buffer;
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [@types/varstruct](https://npmjs.com/package/@types/varstruct)

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

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