Interface PasswordHashResult

Result of a password hashing operation (Argon2).

Example

const { data } = await client.passwordHash({ password: 'hunter2' });
const result: PasswordHashResult = data;
console.log(result.phc); // PHC-format string
console.log(result.hash, result.salt, result.params);

interface PasswordHashResult {
    hash: string;
    salt: string;
    params: { t: number; m: number; p: number };
    algorithm: string;
    phc: string;
}

Index

Properties

hash salt params algorithm phc

Properties

hash

hash: string

Hex-encoded password hash.

salt

salt: string

Hex-encoded salt used for hashing.

params

params: { t: number; m: number; p: number }

Argon2 cost parameters (time, memory, parallelism).

Type Declaration

t: number

Time cost (iterations).
m: number

Memory cost (KiB).
p: number

Parallelism factor.

algorithm

algorithm: string

Argon2 variant used (e.g. "argon2id").

phc

phc: string

PHC-format encoded hash string.

Interface PasswordHashResult

Example

Index

Properties

Properties

hash

salt

params

Type Declaration

t: number

m: number

p: number

algorithm

phc

Settings

On This Page