ear-tag

Import

Import

import * as api from "@fungi.computer/ear-tag";

Exports

Kind	Export	Description
Ttype alias	GenerateKeyOptions	Options for generating a bearer key.
Ttype alias	GeneratedKey	A newly generated bearer key and the digest safe to retain in storage.
fnfunction	generateKey()	Generate a cryptographically random bearer key.
fnfunction	hashKey()	Hash a bearer key with Worker-compatible Web Crypto.
fnfunction	generateKeyAndHash()	Generate a bearer key and the digest its owner should persist.

GenerateKeyOptionsTtype alias

Signature

type GenerateKeyOptions = Readonly<{
  length?: number;
  prefix?: string;
}>;

Options for generating a bearer key.

---

GeneratedKeyTtype alias

Signature

type GeneratedKey = Readonly<{
  digest: string;
  key: string;
}>;

A newly generated bearer key and the digest safe to retain in storage.

generateKey()fnfunction

Signature

function generateKey(options?): string;

Generate a cryptographically random bearer key.

Parameters

Parameter	Type
options	GenerateKeyOptions

Returns

string

---

hashKey()fnfunction

Signature

function hashKey(key): Promise<string>;

Hash a bearer key with Worker-compatible Web Crypto.

Parameters

Parameter	Type
key	string

Returns

Promise<string>

---

generateKeyAndHash()fnfunction

Signature

function generateKeyAndHash(options?): Promise<
  Readonly<{
    digest: string;
    key: string;
  }>
>;

Generate a bearer key and the digest its owner should persist.

Parameters

Parameter	Type
options	GenerateKeyOptions

Returns

Promise<Readonly<{ digest: string; key: string; }>>