Class PhcFormatter<Params>

Phc formatter is used to serialize a hash to a phc string and deserialize it back to a PHC object.

Type Parameters

Params extends Record<string, string | number> = Record<string, string | number>

Index

Constructors

Methods

serialize deserialize

Constructors

constructor

new PhcFormatter<
Params extends
Record<string, string | number> = Record<string, string | number>,
>(): PhcFormatter<Params>
Type Parameters
- Params extends Record<string, string | number> = Record<string, string | number>
Returns PhcFormatter<Params>

Methods

serialize

serialize(
    salt: Buffer,
    hash: Buffer,
    options: { id: string; params?: Params; version?: string | number },
): string
Serialize salt and hash with predefined options.
Parameters
- salt: Buffer
- hash: Buffer
- options: { id: string; params?: Params; version?: string | number }
Returns string
- Defined in src/phc_formatter.ts:32

deserialize

deserialize(phcString: string): PhcNode<Params>
Deserialize a PHC string to an object
Parameters
- phcString: string
  The PHC string to deserialize
Returns PhcNode<Params>
The deserialized PHC node object
- Defined in src/phc_formatter.ts:52