# @hyperledger/aries-askar-nodejs

> Nodejs wrapper for Aries Askar

Latest version **0.2.3** (published 2024-07-03) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @hyperledger/aries-askar-nodejs
pnpm add @hyperledger/aries-askar-nodejs
yarn add @hyperledger/aries-askar-nodejs
bun add @hyperledger/aries-askar-nodejs
```

## Health

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

Positive: has types; no vulnerabilities; high maintenance score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.3 |
| Published | 2024-07-03 |
| First published | 2023-02-03 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 18 |
| Dependencies | 6 |
| Unpacked size | 179.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 87 |
| Author | Hyperledger |
| Maintainers | peter.somogyvari, hyperledger-ghci, hyperledger-lf |

## Links

- npm: https://www.npmjs.com/package/@hyperledger/aries-askar-nodejs
- Repository: https://github.com/hyperledger/aries-askar
- Homepage: https://github.com/hyperledger/aries-askar/tree/main/wrappers/javascript/packages/aries-askar-nodejs
- Issues: https://github.com/hyperledger/aries-askar/issues
- npm.io page: https://npm.io/package/@hyperledger/aries-askar-nodejs

## Dependencies (6)

- [ref-array-di](https://npm.io/package/ref-array-di.md) ^1.2.2
- [ref-struct-di](https://npm.io/package/ref-struct-di.md) ^1.1.1
- [@2060.io/ffi-napi](https://npm.io/package/@2060.io/ffi-napi.md) ^4.0.9
- [@2060.io/ref-napi](https://npm.io/package/@2060.io/ref-napi.md) ^3.0.6
- [@mapbox/node-pre-gyp](https://npm.io/package/@mapbox/node-pre-gyp.md) ^1.0.11
- [@hyperledger/aries-askar-shared](https://npm.io/package/@hyperledger/aries-askar-shared.md) 0.2.3

## Recent versions

- 0.2.3 (latest) — 2024-07-03
- 0.2.0-dev.6 (alpha) — 2024-01-29
- 0.2.1 — 2024-04-10
- 0.2.0 — 2024-02-12
- 0.2.0-dev.5 — 2023-12-21
- 0.2.0-dev.4 — 2023-12-21
- 0.2.0-dev.3 — 2023-11-15
- 0.2.0-dev.2 — 2023-11-13
- 0.2.0-dev.1 — 2023-09-26
- 0.1.1 — 2023-08-04
- 0.1.0 — 2023-06-02
- 0.1.0-dev.12 — 2023-06-01
- 0.1.0-dev.11 — 2023-05-26
- 0.1.0-dev.10 — 2023-05-22
- 0.1.0-dev.9 — 2023-05-17
- … 8 more at https://npm.io/package/@hyperledger/aries-askar-nodejs/versions

## README

# Aries Askar NodeJS

Wrapper for Nodejs around Aries Askar

## Requirements

This library requires (and has been tested extensively with) Node.js version `18.x`. Newer versions might also work, but they have not been tested.

## Installation

```sh
yarn add @hyperledger/aries-askar-nodejs
```

## Setup

You can import all types and classes from the `@hyperledger/aries-askar-nodejs` library:

```typescript
import { Key, KeyAlgs } from '@hyperledger/aries-askar-nodejs'

const seed = Uint8Array.from(Buffer.from('testseed000000000000000000000001'))
const key = Key.fromSeed({ algorithm: KeyAlgs.Bls12381G1, seed })
```

> **Note**: If you want to use this library in a cross-platform environment you need to import methods from the `@hyperledger/aries-askar-shared` package instead. This is a platform independent package that allows to register the native bindings. The `@hyperledger/aries-askar-nodejs` package uses this package under the hood. See the [Aries Askar Shared README](https://github.com/hyperledger/aries-askar/tree/main/wrappers/javascript/aries-askar-shared/README.md) for documentation on how to use this package.

## Version Compatibility

The JavaScript wrapper is versioned independently from the native bindings. The following table shows the compatibility between the different versions:

| Aries Askar | JavaScript Wrapper |
| ----------- | ------------------ |
| v0.2.9      | v0.1.0, v0.1.1     |
| v0.3.1      | v0.2.0             |

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