Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugoalh/fnv-es
An ES (JavaScript & TypeScript) module to get the non-cryptographic hash of the data with algorithm Fowler-Noll-Vo (FNV).
https://github.com/hugoalh/fnv-es
es fnv fowler-noll-vo hash javascript js modulejs ts typescript
Last synced: 18 days ago
JSON representation
An ES (JavaScript & TypeScript) module to get the non-cryptographic hash of the data with algorithm Fowler-Noll-Vo (FNV).
- Host: GitHub
- URL: https://github.com/hugoalh/fnv-es
- Owner: hugoalh
- License: other
- Created: 2025-01-17T06:53:54.000Z (20 days ago)
- Default Branch: main
- Last Pushed: 2025-01-17T09:23:30.000Z (20 days ago)
- Last Synced: 2025-01-17T10:27:01.497Z (19 days ago)
- Topics: es, fnv, fowler-noll-vo, hash, javascript, js, modulejs, ts, typescript
- Language: TypeScript
- Homepage:
- Size: 25.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Fowler-Noll-Vo (FNV) (ES)
[**⚖️** MIT](./LICENSE.md)
[](https://github.com/hugoalh/fnv-es)
[](https://jsr.io/@hugoalh/fnv)
[](https://www.npmjs.com/package/@hugoalh/fnv)
An ES (JavaScript & TypeScript) module to get the non-cryptographic hash of the data with algorithm Fowler-Noll-Vo (FNV).
Currently supported variants of 0, 1, and 1a, and bits size of 32, 64, 128, 256, 512, and 1024.
## 🔰 Begin
### 🎯 Targets
| | **Remote** | **JSR** | **NPM** |
|:--|:--|:--|:--|
| **[Bun](https://bun.sh/)** >= v1.1.0 | ❌ | ❓ | ✔️ |
| **[Cloudflare Workers](https://workers.cloudflare.com/)** | ❌ | ❓ | ✔️ |
| **[Deno](https://deno.land/)** >= v1.42.0 | ✔️ | ✔️ | ✔️ |
| **[NodeJS](https://nodejs.org/)** >= v16.13.0 | ❌ | ❓ | ✔️ |
> [!NOTE]
> - It is possible to use this module in other methods/ways which not listed in here, however those methods/ways are not officially supported, and should beware maybe cause security issues.
### #️⃣ Resources Identifier
- **Remote - GitHub Raw:**
```
https://raw.githubusercontent.com/hugoalh/fnv-es/{Tag}/mod.ts
```
- **JSR:**
```
[jsr:]@hugoalh/fnv[@{Tag}]
```
- **NPM:**
```
[npm:]@hugoalh/fnv[@{Tag}]
```
> [!NOTE]
> - For usage of remote resources, it is recommended to import the entire module with the main path `mod.ts`, however it is also able to import part of the module with sub path if available, but do not import if:
>
> - it's path has an underscore prefix (e.g.: `_foo.ts`, `_util/bar.ts`), or
> - it is a benchmark or test file (e.g.: `foo.bench.ts`, `foo.test.ts`), or
> - it's symbol has an underscore prefix (e.g.: `_bar`, `_foo`).
>
> These elements are not considered part of the public API, thus no stability is guaranteed for them.
> - For usage of JSR or NPM resources, it is recommended to import the entire module with the main entrypoint, however it is also able to import part of the module with sub entrypoint if available, please visit the [file `jsr.jsonc`](./jsr.jsonc) property `exports` for available sub entrypoints.
> - It is recommended to use this module with tag for immutability.
### 🛡️ Runtime Permissions
- File System - Read \[Deno: `read`; NodeJS (>= v20.9.0) 🧪: `fs-read`\]
- *Resources* (Optional)
## 🧩 APIs
- ```ts
class FNV0 {
constructor(size: FNVBitsSize, data?: FNVAcceptDataType);
get freezed(): boolean;
get size(): FNVBitsSize;
freeze(): this;
hash(): bigint;
hashBase16(): string;
hashBase32Hex(): string;
hashBase36(): string;
hashBigInt(): bigint;
hashHex(): string;
hashHexPadding(): string;
update(data: FNVAcceptDataType): this;
static fromStream(size: FNVBitsSize, stream: ReadableStream): Promise;
}
```
- ```ts
class FNV1 {
constructor(size: FNVBitsSize, data?: FNVAcceptDataType);
get freezed(): boolean;
get size(): FNVBitsSize;
freeze(): this;
hash(): bigint;
hashBase16(): string;
hashBase32Hex(): string;
hashBase36(): string;
hashBigInt(): bigint;
hashHex(): string;
hashHexPadding(): string;
update(data: FNVAcceptDataType): this;
static fromStream(size: FNVBitsSize, stream: ReadableStream): Promise;
}
```
- ```ts
class FNV1a {
constructor(size: FNVBitsSize, data?: FNVAcceptDataType);
get freezed(): boolean;
get size(): FNVBitsSize;
freeze(): this;
hash(): bigint;
hashBase16(): string;
hashBase32Hex(): string;
hashBase36(): string;
hashBigInt(): bigint;
hashHex(): string;
hashHexPadding(): string;
update(data: FNVAcceptDataType): this;
static fromStream(size: FNVBitsSize, stream: ReadableStream): Promise;
}
```
- ```ts
type FNVAcceptDataType = string | BigUint64Array | Uint8Array | Uint16Array | Uint32Array;
```
- ```ts
type FNVBitsSize = 32 | 64 | 128 | 256 | 512 | 1024;
```
> [!NOTE]
> - For the full or prettier documentation, can visit via:
> - [Deno CLI `deno doc`](https://docs.deno.com/runtime/reference/cli/documentation_generator/)
> - [JSR](https://jsr.io/@hugoalh/fnv)
## ✍️ Examples
- ```ts
new FNV1(32, "hello").hashHexPadding();
//=> "4F9F2CAB"
```