MalformedApiKeyError

Thrown at construction when a typed key (ingestion or data plane) is set to a value that is not a key of that kind. The message names where the value came from and what it looks like instead, and never echoes the value.

​

Extends

• HoneyHiveError

​

Constructors

​

Constructor

new MalformedApiKeyError(keyKind, source, requirement): MalformedApiKeyError

​

Parameters

keyKind

"ingestion" | "dataPlane"

source

string

requirement

string

​

Returns

MalformedApiKeyError

​

Overrides

HoneyHiveError.constructor

​

keyKind

readonly keyKind: "ingestion" | "dataPlane"

The kind of key the value was supplied as.

---

​

source

readonly source: string

The option or environment variable the value came from.

---

​

messageFor()

messageFor(source): string

The same message with source named as where the value came from, for a caller that supplied the value under a different name.

​

Parameters

source

string

​

Returns

string

---