https://github.com/hugoalh/blake-es
An ECMAScript (JavaScript & TypeScript) module to get the non-cryptographic hash of the data with algorithm Blake.
https://github.com/hugoalh/blake-es
blake blake2b blake2s ecmascript ecmascript-module es es-module esm esmodule hash javascript js ts typescript
Last synced: 7 months ago
JSON representation
An ECMAScript (JavaScript & TypeScript) module to get the non-cryptographic hash of the data with algorithm Blake.
- Host: GitHub
- URL: https://github.com/hugoalh/blake-es
- Owner: hugoalh
- License: other
- Created: 2025-07-22T09:57:00.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-29T09:47:51.000Z (9 months ago)
- Last Synced: 2025-09-05T12:55:13.432Z (9 months ago)
- Topics: blake, blake2b, blake2s, ecmascript, ecmascript-module, es, es-module, esm, esmodule, hash, javascript, js, ts, typescript
- Language: TypeScript
- Homepage:
- Size: 439 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Blake (ES)
[**⚖️** MIT](./LICENSE.md)
[](https://github.com/hugoalh/blake-es)
[](https://jsr.io/@hugoalh/blake)
[](https://www.npmjs.com/package/@hugoalh/blake)
An ECMAScript module to get the non-cryptographic hash of the data with algorithm Blake.
## 🌟 Features
- Support custom output length.
- Support variants of 2B and 2S.
## 🎯 Targets
| **Runtime \\ Source** | **GitHub Raw** | **JSR** | **NPM** |
|:--|:-:|:-:|:-:|
| **[Bun](https://bun.sh/)** >= v1.1.0 | ❌ | ✔️ | ✔️ |
| **[Deno](https://deno.land/)** >= v2.1.0 | ✔️ | ✔️ | ✔️ |
| **[NodeJS](https://nodejs.org/)** >= v20.9.0 | ❌ | ✔️ | ✔️ |
## 🛡️ Runtime Permissions
This does not request any runtime permission.
## #️⃣ Sources
- GitHub Raw
```
https://raw.githubusercontent.com/hugoalh/blake-es/{Tag}/mod.ts
```
- JSR
```
jsr:@hugoalh/blake[@{Tag}]
```
- NPM
```
npm:@hugoalh/blake[@{Tag}]
```
> [!NOTE]
> - It is recommended to include tag for immutability.
> - These are not part of the public APIs hence should not be used:
> - Benchmark/Test file (e.g.: `example.bench.ts`, `example.test.ts`).
> - Entrypoint name or path include any underscore prefix (e.g.: `_example.ts`, `foo/_example.ts`).
> - Identifier/Namespace/Symbol include any underscore prefix (e.g.: `_example`, `Foo._example`).
## ⤵️ Entrypoints
| **Name** | **Path** | **Description** |
|:--|:--|:--|
| `.` | `./mod.ts` | Default. |
| `./2b` | `./2b.ts` | Variant of 2B. |
| `./2s` | `./2s.ts` | Variant of 2S. |
## 🧩 APIs
- ```ts
class Blake2B {
constructor(input?: Blake2BOptions);
get freezed(): boolean;
get length(): number;
freeze(): this;
hash(): Uint8Array;
hashHex(): string;
update(data: Blake2AcceptDataType): this;
updateFromStream(stream: ReadableStream): Promise;
}
```
- ```ts
class Blake2S {
constructor(input?: Blake2Options);
get freezed(): boolean;
get length(): number;
freeze(): this;
hash(): Uint8Array;
hashHex(): string;
update(data: Blake2AcceptDataType): this;
updateFromStream(stream: ReadableStream): Promise;
}
```
- ```ts
interface Blake2Options {
data?: Blake2AcceptDataType;
key?: Uint8Array;
length?: number;
}
```
- ```ts
interface Blake2BOptions extends Blake2Options {
personal?: string | Uint8Array;
salt?: string | Uint8Array;
}
```
- ```ts
type Blake2AcceptDataType =
| string
| Uint8Array;
```
> [!NOTE]
> - For the full or prettier documentation, can visit via:
> - [Deno CLI `deno doc`](https://docs.deno.com/runtime/reference/cli/doc/)
> - [JSR](https://jsr.io/@hugoalh/blake)
## ✍️ Examples
- ```ts
new Blake2B("The quick brown fox jumps over the lazy dog").hashHex();
//=> "A8ADD4BDDDFD93E4877D2746E62817B116364A1FA7BC148D95090BC7333B3673F82401CF7AA2E4CB1ECD90296E3F14CB5413F8ED77BE73045B13914CDCD6A918"
```