Class LocalResponse

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

Hierarchy

LocalResponseBase
- LocalResponse

Index

Constructors

Properties

Methods

asDict getHmacSignature init isValidHmacSignature loadPrediction

Constructors

constructor

new LocalResponse(inputFile: string | Buffer<ArrayBufferLike>): v1.LocalResponse
Creates an instance of LocalResponse.
Parameters
- inputFile: string | Buffer<ArrayBufferLike>
Returns v1.LocalResponse
Inherited from LocalResponseBase.constructor
- Defined in src/parsing/localResponseBase.ts:20

Properties

`Protected`initialized

initialized: boolean = false

Whether the local response payload has been loaded.

Methods

asDict

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

Returns Promise<StringDict>
A JSON-like object.
Inherited from LocalResponseBase.asDict
- Defined in src/parsing/localResponseBase.ts:54

getHmacSignature

getHmacSignature(
    secretKey:
        | string
        | Buffer<ArrayBufferLike>
        | Uint8Array<ArrayBufferLike>,
): string
Returns the HMAC signature of the local response from the secret key provided.
Parameters
- secretKey: string | Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
  Secret key, either a string or a byte/byte array.
Returns string
The HMAC signature of the local response.
Inherited from LocalResponseBase.getHmacSignature
- Defined in src/parsing/localResponseBase.ts:71

init

init(): Promise<void>
Loads the local payload from a string, buffer, or file path.

Returns Promise<void>
Inherited from LocalResponseBase.init
- Defined in src/parsing/localResponseBase.ts:26

isValidHmacSignature

isValidHmacSignature(
    secretKey:
        | string
        | Buffer<ArrayBufferLike>
        | Uint8Array<ArrayBufferLike>,
    signature: string,
): boolean
Checks if the HMAC signature of the local response is valid.
Parameters
- secretKey: string | Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
  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.
Inherited from LocalResponseBase.isValidHmacSignature
- Defined in src/parsing/localResponseBase.ts:93

loadPrediction

loadPrediction<T extends v1.Inference<v1.Prediction, v1.Prediction>>(
productClass: new (httpResponse: StringDict) => T,
): Promise<v1.AsyncPredictResponse<T> | v1.PredictResponse<T>>
Loads a local JSON payload into a typed prediction response wrapper.
Type Parameters
- T extends v1.Inference<v1.Prediction, v1.Prediction>
Parameters
- productClass: new (httpResponse: StringDict) => T
Returns Promise<v1.AsyncPredictResponse<T> | v1.PredictResponse<T>>
- Defined in src/v1/parsing/localResponse.ts:12