Skip to content 

CustomErrorWithProps Class

Packages > @fluidframework/telemetry-utils > CustomErrorWithProps

Helper class for error tracking. Object of this instance will record all of their properties when logged with logger. Care needs to be taken not to log PII information! Logger ignores all properties from any other error objects (not being instance of CustomErrorWithProps), with exception of ‘message’ & ‘stack’ properties if they exists on error object. In other words, logger logs only what it knows about and has good confidence it does not container PII information.

Signature:

export declare class CustomErrorWithProps extends Error 

Extends: Error

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(message, props) Constructs a new instance of the CustomErrorWithProps class

Methods

List of methods on this class
Method Modifiers Description
getCustomProperties()

Constructors

CustomErrorWithProps.(constructor)

Constructs a new instance of the CustomErrorWithProps class

Signature:

constructor(message: string, props?: ITelemetryProperties);

Parameters

List of parameters
Parameter Type Description
message string
props ITelemetryProperties

Methods

getCustomProperties

Signature:

getCustomProperties(): ITelemetryProperties;

Returns:

ITelemetryProperties