Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refine tsdoc description. #233

Merged
merged 1 commit into from
Aug 6, 2023
Merged

Refine tsdoc description. #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/errors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,17 +54,17 @@ export class DecapError extends HpkeError {}
export class ExportError extends HpkeError {}

/**
* Context AEAD seal() failure.
* seal() failure.
*/
export class SealError extends HpkeError {}

/**
* Context AEAD open() failure.
* open() failure.
*/
export class OpenError extends HpkeError {}

/**
* Context AEAD sequence number overflow.
* Sequence number overflow on the encryption context.
*/
export class MessageLimitReachedError extends HpkeError {}

Expand Down
28 changes: 14 additions & 14 deletions src/identifiers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Supported HPKE modes.
* The supported HPKE modes.
*/
export const Mode = {
Base: 0x00,
Expand All @@ -9,12 +9,12 @@ export const Mode = {
} as const;

/**
* The type of the Supported HPKE modes.
* The type alias of the supported HPKE modes.
*/
export type Mode = typeof Mode[keyof typeof Mode];

/**
* Supported Key Encapsulation Mechanism (KEM) identifiers.
* The supported Key Encapsulation Mechanism (KEM) identifiers.
*
* @deprecated Use {@link KdfId} instead.
*/
Expand All @@ -28,24 +28,24 @@ export const Kem = {
} as const;

/**
* The type of the supported KEM identifiers.
* The type alias of the supported KEM identifiers.
*
* @deprecated Use {@link KdfId} instead.
*/
export type Kem = typeof Kem[keyof typeof Kem];

/**
* Supported Key Encapsulation Mechanism (KEM) identifiers.
* The supported Key Encapsulation Mechanism (KEM) identifiers.
*/
export const KemId = Kem;

/**
* The type of the supported KEM identifiers.
* The type alias of the supported KEM identifiers.
*/
export type KemId = typeof KemId[keyof typeof KemId];

/**
* Supported Key Derivation Function (KDF) identifiers.
* The supported Key Derivation Function (KDF) identifiers.
*
* @deprecated Use {@link KdfId} instead.
*/
Expand All @@ -56,24 +56,24 @@ export const Kdf = {
} as const;

/**
* The type of the supported KDF identifiers.
* The type alias of the supported KDF identifiers.
*
* @deprecated Use {@link KdfId} instead.
*/
export type Kdf = typeof Kdf[keyof typeof Kdf];

/**
* Supported Key Derivation Function (KDF) identifiers.
* The supported Key Derivation Function (KDF) identifiers.
*/
export const KdfId = Kdf;

/**
* The type of the supported KDF identifiers.
* The type alias of the supported KDF identifiers.
*/
export type KdfId = typeof KdfId[keyof typeof KdfId];

/**
* Supported Authenticated Encryption with Associated Data (AEAD) identifiers.
* The supported Authenticated Encryption with Associated Data (AEAD) identifiers.
*
* @deprecated Use {@link AeadId} instead.
*/
Expand All @@ -85,18 +85,18 @@ export const Aead = {
} as const;

/**
* The type of the supported AEAD identifiers.
* The type alias of the supported AEAD identifiers.
*
* @deprecated Use {@link AeadId} instead.
*/
export type Aead = typeof Aead[keyof typeof Aead];

/**
* Supported Authenticated Encryption with Associated Data (AEAD) identifiers.
* The supported Authenticated Encryption with Associated Data (AEAD) identifiers.
*/
export const AeadId = Aead;

/**
* The type of the supported AEAD identifiers.
* The type alias of the supported AEAD identifiers.
*/
export type AeadId = typeof AeadId[keyof typeof AeadId];
Loading