Interface HashDriverContract

The contract Hash drivers should adhere to

interface HashDriverContract {
    isValidHash(value: string): boolean;
    make(value: string): Promise<string>;
    verify(hashedValue: string, plainValue: string): Promise<boolean>;
    needsReHash(hashedValue: string): boolean;
}

Implemented by

Index

Methods

isValidHash make verify needsReHash

Methods

isValidHash

isValidHash(value: string): boolean
Check if the value is a valid hash. This method just checks for the formatting of the hash
Parameters
- value: string
Returns boolean
- Defined in src/types.ts:20

make

make(value: string): Promise<string>
Hash plain text value
Parameters
- value: string
Returns Promise<string>
- Defined in src/types.ts:25

verify

verify(hashedValue: string, plainValue: string): Promise<boolean>
Verify the plain text value against an existing hash
Parameters
- hashedValue: string
- plainValue: string
Returns Promise<boolean>
- Defined in src/types.ts:30

needsReHash

needsReHash(hashedValue: string): boolean
Find if the hash value needs a rehash or not.
Parameters
- hashedValue: string
Returns boolean
- Defined in src/types.ts:35