Skip to content

Class: AuthenticationError ​

Defined in: netconf/src/errors.ts:80

Authentication failed. reason says whether the server refused us, our private key was unusable, or a prompt couldn't be answered.

Extends ​

Constructors ​

Constructor ​

ts
new AuthenticationError(message, options?): AuthenticationError;

Defined in: netconf/src/errors.ts:87

Parameters ​

message ​

string

options? ​

AuthenticationErrorOptions

Returns ​

AuthenticationError

Overrides ​

TransportError.constructor

Properties ​

code ​

ts
readonly code: "ERR_NETCONF_AUTH" = 'ERR_NETCONF_AUTH';

Defined in: netconf/src/errors.ts:83

Stable, machine-readable error code.

Overrides ​

TransportError.code


name ​

ts
name: string = 'AuthenticationError';

Defined in: netconf/src/errors.ts:82

Always 'AuthenticationError'.

Overrides ​

TransportError.name


reason ​

ts
readonly reason: AuthenticationReason;

Defined in: netconf/src/errors.ts:85

Why authentication failed; see AuthenticationReason.

Released under the MIT Licence.