Class LocalResponse

Local response loaded from a file. Note: Has to be initialized through init() before use.

Index

Constructors

Methods

asDict getHmacSignature init isValidHmacSignature

Constructors

constructor

new LocalResponse(inputFile): LocalResponse
Creates an instance of LocalResponse.
Parameters
- inputFile: string | Buffer
Returns LocalResponse
- Defined in src/input/localResponse.ts:18

Methods

asDict

asDict(): StringDict
Returns the dictionary representation of the file.

Returns StringDict
A JSON-like object.
- Defined in src/input/localResponse.ts:47

getHmacSignature

getHmacSignature(secretKey): string
Returns the HMAC signature of the local response, from the secret key provided.
Parameters
- secretKey: string | Buffer | Uint8Array
  Secret key, either a string or a byte/byte array.
Returns string
The HMAC signature of the local response.
- Defined in src/input/localResponse.ts:61

init

init(): Promise<void>
Returns Promise<void>
- Defined in src/input/localResponse.ts:23

isValidHmacSignature

isValidHmacSignature(secretKey, signature): boolean
Checks if the HMAC signature of the local response is valid.
Parameters
- secretKey: string | Buffer | Uint8Array
  Secret key, either a string or a byte/byte array.
- signature: string
  The signature to be compared with.
Returns boolean
True if the HMAC signature is valid.
- Defined in src/input/localResponse.ts:78