Skip to main content
webpack / WebpackOptionsValidationError

Class: WebpackOptionsValidationError

Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:9

Extends

Constructors

Constructor

new WebpackOptionsValidationError(errors, schema, configuration?): ValidationError
Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:15

Parameters

errors
SchemaUtilErrorObject[] array of error objects
schema
Schema schema
configuration?
ValidationErrorConfiguration configuration

Returns

ValidationError

Overrides

Error.constructor

Properties

baseDataPath

baseDataPath: string
Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:27

errors

errors: SchemaUtilErrorObject[]
Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:21

headerName

headerName: string
Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:25

message

message: string
Defined in: docs.webpack.js.org/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string
Defined in: docs.webpack.js.org/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

postFormatter

postFormatter: PostFormatter
Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:29

schema

schema: Schema
Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:23

stack?

optional stack: string
Defined in: docs.webpack.js.org/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number
Defined in: docs.webpack.js.org/node_modules/@types/node/globals.d.ts:67 The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)). The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

formatSchema()

formatSchema(schema, logic?, prevSchemas?): string
Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:41

Parameters

schema
Schema schema
logic?
boolean logic
prevSchemas?
object[] prev schemas

Returns

string formatted schema

formatValidationError()

formatValidationError(error): string
Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:68

Parameters

error
SchemaUtilErrorObject error object

Returns

string formatted error object

formatValidationErrors()

formatValidationErrors(errors): string
Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:73

Parameters

errors
SchemaUtilErrorObject[] errors

Returns

string formatted errors

getSchemaPart()

getSchemaPart(path): Schema
Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:34

Parameters

path
string path

Returns

Schema schema

getSchemaPartDescription()

getSchemaPartDescription(schemaPart?): string
Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:63

Parameters

schemaPart?
Schema schema part

Returns

string schema part description

getSchemaPartText()

getSchemaPartText(schemaPart?, additionalPath?, needDot?, logic?): string
Defined in: webpack/node_modules/schema-utils/declarations/ValidationError.d.ts:53

Parameters

schemaPart?
Schema schema part
additionalPath?
additional path boolean | string[]
needDot?
boolean true when need dot
logic?
boolean logic

Returns

string schema part text

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void
Defined in: docs.webpack.js.org/node_modules/@types/node/globals.d.ts:51 Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}. The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace. The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject
object
constructorOpt?
Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any
Defined in: docs.webpack.js.org/node_modules/@types/node/globals.d.ts:55

Parameters

err
Error
stackTraces
CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace