Class LocalResponse

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

Hierarchy

LocalResponse

Index

Constructors

Properties

file inputHandle

Methods

asDict getHmacSignature init isValidHmacSignature

Constructors

constructor

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

Properties

`Private` file

file: Buffer

`Private` `Readonly` inputHandle

inputHandle: string | Buffer

Methods

asDict

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

Returns
A JSON-like object.

Returns StringDict
- Defined in src/input/localResponse.ts:47

getHmacSignature

getHmacSignature(secretKey: string | Buffer | Uint8Array): string
Returns the HMAC signature of the local response, from the secret key provided.

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

init

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

isValidHmacSignature

isValidHmacSignature(secretKey: string | Buffer | Uint8Array, signature: string): boolean
Checks if the HMAC signature of the local response is valid.

Returns
True if the HMAC signature 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
- Defined in src/input/localResponse.ts:78

Generated using TypeDoc