verifactu-sdk API

---

verifactu-sdk API / BusinessValidationError

Class: BusinessValidationError

Defined in: src/errors/VerifactuError.ts:141

Error raised by the cross-field business-rule validator (validators/businessRules.ts).

Each instance corresponds to one rule violation (e.g. AEAT 1108 / 1146 / 1199). Multiple violations are returned as an array of ValidationResult by the validator; this error is the thrown form when the caller asks for fail-fast behaviour.

Example

throw new BusinessValidationError('ClaveRegimen 11 requires TipoImpositivo 21', {
  code: '1206',
  category: 'record',
  field: 'breakdown.0.taxRate',
});

Extends

• VerifactuError

Constructors

Constructor

new BusinessValidationError(message, options?): BusinessValidationError

Defined in: src/errors/VerifactuError.ts:146

Parameters

message

string

English description of the rule violation.

options?

VerifactuErrorOptions = {}

Optional metadata; populate code when the rule maps to a catalog entry.

Returns

BusinessValidationError

Overrides

VerifactuError.constructor

Properties

stackTraceLimit

static stackTraceLimit: number

Defined in: 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

VerifactuError.stackTraceLimit

---

cause?

optional cause?: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

The cause of the error.

Inherited from

VerifactuError.cause

---

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

VerifactuError.name

---

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

VerifactuError.message

---

stack?

optional stack?: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

VerifactuError.stack

---

code

readonly code: string | undefined

Defined in: src/errors/VerifactuError.ts:75

AEAT error code, when known.

Inherited from

VerifactuError.code

---

category

readonly category: ErrorCategory | undefined

Defined in: src/errors/VerifactuError.ts:77

AEAT category, when known.

Inherited from

VerifactuError.category

---

field

readonly field: string | undefined

Defined in: src/errors/VerifactuError.ts:79

Field path (dotted) of the offending value.

Inherited from

VerifactuError.field

---

invoiceId

readonly invoiceId: VerifactuErrorInvoiceId | undefined

Defined in: src/errors/VerifactuError.ts:81

Invoice identifier the error pertains to.

Inherited from

VerifactuError.invoiceId

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: 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

VerifactuError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

VerifactuError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: 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

VerifactuError.prepareStackTrace

---

isError()

static isError(value): value is Error

Defined in: node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

value

unknown

The value to check

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

VerifactuError.isError