# @the-/secret

> Secret store for the-frameworks

Latest version **16.0.1** (published 2020-04-27) · MIT license · 0 weekly downloads

## Install

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

## 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 | 16.0.1 |
| Published | 2020-04-27 |
| First published | 2019-03-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 5 |
| Unpacked size | 115.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | lib, the |

## Links

- npm: https://www.npmjs.com/package/@the-/secret
- Repository: https://github.com/the-labo/the
- Homepage: https://github.com/the-labo/the/tree/master/packages/secret#readme
- Issues: https://github.com/the-labo/the#issues
- npm.io page: https://npm.io/package/@the-/secret

## Dependencies (5)

- [qs](https://npm.io/package/qs.md) ^6.9.3
- [abind](https://npm.io/package/abind.md) ^1.0.5
- [objnest](https://npm.io/package/objnest.md) ^5.0.10
- [aslogger](https://npm.io/package/aslogger.md) ^2.0.1
- [@the-/util-file](https://npm.io/package/@the-/util-file.md) ^15.7.2

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 16.0.1 (latest) — 2020-04-27
- 16.0.0 — 2019-07-30
- 15.4.5 — 2019-05-20
- 15.4.4 — 2019-05-20
- 15.4.0 — 2019-04-30
- 15.2.3 — 2019-04-08
- 15.2.2 — 2019-04-08
- 15.2.0 — 2019-03-31
- 15.1.4 — 2019-03-31
- 15.1.3 — 2019-03-30
- 15.1.2 — 2019-03-30
- 15.1.0 — 2019-03-29
- 15.0.3 — 2019-03-21

## README

@the-/secret
==========

<!---
This file is generated by @the-/templates. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![npm Version][bd_npm_shield_url]][bd_npm_url]

[bd_repo_url]: https://github.com/the-labo/the
[bd_npm_url]: http://www.npmjs.org/package/@the-/secret
[bd_npm_shield_url]: http://img.shields.io/npm/v/@the-/secret.svg?style=flat

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Secret store for the-frameworks

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>




<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/readme/01.Installation.md.hbs" Start -->

<a name="section-doc-readme-01-installation-md"></a>

Installation
-----

```bash
$ npm install @the-/secret --save
```


<!-- Section from "doc/readme/01.Installation.md.hbs" End -->

<!-- Section from "doc/readme/02.Usage.md.hbs" Start -->

<a name="section-doc-readme-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const theSecret = require('@the-/secret')

async function tryExample() {
  const secret = theSecret('./secrets.json', 'xxxxxxxxxxxx')

  await secret.encrypt()
  await secret.decrypt()
}

tryExample().catch((err) => console.error(err))

```


<!-- Section from "doc/readme/02.Usage.md.hbs" End -->


<!-- Sections Start -->

<a name="api"></a>

## API Guide


- module:@the-/secret
  - [.create(args)](./doc/api/api.md#module_@the-/secret.create)
  - [.mixins](./doc/api/api.md#module_@the-/secret.mixins)
  - [.theSecret()](./doc/api/api.md#module_@the-/secret.theSecret)
  - [.TheSecret](./doc/api/api.md#module_@the-/secret.TheSecret)
- module:@the-/secret.helpers
  - [.cipher](./doc/api/api.md#module_@the-/secret.helpers.cipher)
- module:@the-/secret.mixins
  - [.cryptoMix()](./doc/api/api.md#module_@the-/secret.mixins.cryptoMix)
  - [.lockMix(Class)](./doc/api/api.md#module_@the-/secret.mixins.lockMix)
- module:@the-/secret.mixins.cryptoMix
  - [~CryptoMixed](./doc/api/api.md#module_@the-/secret.mixins.cryptoMix~CryptoMixed)
- module:@the-/secret.mixins.lockMix
  - [~LockMixed](./doc/api/api.md#module_@the-/secret.mixins.lockMix~LockMixed)
- TheSecret
  - [#decrypt()](./doc/api/api.md#TheSecret#decrypt)
  - [#encrypt()](./doc/api/api.md#TheSecret#encrypt)
  - [#get(name)](./doc/api/api.md#TheSecret#get)
  - [#writeout(filename)](./doc/api/api.md#TheSecret#writeout)

See [API Guide](./doc/api/api.md) for more detail


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/the-labo/the/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [THE Labo][the_labo_url]

[the_labo_url]: https://github.com/the-labo

<!-- Links End -->

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