Class: BulkRefusedError

@kortexya/reasoninglayer / BulkRefusedError

Class: BulkRefusedError

Defined in: src/errors.ts:527

A bulk write the engine refused row by row (HTTP 422).

Remarks

POST /api/v1/terms/bulk used to answer one message about a feature and write nothing, so a client importing four thousand rows learned that something, somewhere, was wrong. It now names every refused row by its index in the request, and this error carries that list.

Reached three ways, all of them this class:

an ordinary batch where any row was refused (nothing was written);
a partial: true REAL write where EVERY row was refused (again nothing was written — a partial batch that landed something answers 201 instead, with the refusals on BulkAddTermsResponse.errors);
a dryRun: true batch WITHOUT partial that would have been refused.

⚠️ dryRun: true AND partial: true together do NOT throw. Measured 2026-09-21: bulkCreateTerms({terms: [bad, bad], dryRun: true, partial: true}) answers 200 with {termsAdded: 0, dryRun: true, refused: 2, errors: […, …], coreferencedTermIds: []}, because a dry run that wrote nothing has nothing to refuse. That pair is the only shape that answers both halves of a forecast in one call — how many rows would be created AND which rows are bad. A refused dry run without partial throws, and the thrown error carries no coreferencedTermIds, so a caller that expects the throw loses the “N would create, M would merge” half for exactly the files that have a bad row.

Two failures are NOT this error, because neither can be attributed to a row: the end-of-batch constraint propagation answers a ConstraintViolationError for the whole batch, and a persistence failure reverts what the batch inserted.

Example

try {
  await client.terms.bulkCreateTerms({ terms });
} catch (e) {
  if (e instanceof BulkRefusedError) {
    for (const row of e.rows) {
      console.error(`row ${row.index}: ${row.message}`);
    }
  }
}

Extends

ApiError

Constructors

Constructor

new BulkRefusedError(message, body, headers, rows, errorCode?): BulkRefusedError

Defined in: src/errors.ts:538

Parameters

message

string

body

unknown

headers

Headers

rows

readonly BulkRowRefusal[]

errorCode?

string

Returns

BulkRefusedError

Overrides

ApiError.constructor

Properties

body

readonly body: unknown

Defined in: src/errors.ts:55

Parsed response body.

Inherited from

ApiError.body

cause?

optional cause?: unknown

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

Inherited from

ApiError.cause

errorCode

readonly errorCode: string | undefined

Defined in: src/errors.ts:53

Backend error code (from response body error field), if present.

Inherited from

ApiError.errorCode

headers

readonly headers: Headers

Defined in: src/errors.ts:57

Response headers.

Inherited from

ApiError.headers

message

message: string

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

Inherited from

ApiError.message

name

name: string = 'BulkRefusedError'

Defined in: src/errors.ts:528

Overrides

ApiError.name

rows

readonly rows: readonly BulkRowRefusal[]

Defined in: src/errors.ts:536

The refused rows, each naming its index in the request’s terms array.

Remarks

Never empty — the engine answers this shape only when it refused something.

stack?

optional stack?: string

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

Inherited from

ApiError.stack

status

readonly status: number

Defined in: src/errors.ts:51

HTTP status code.

Inherited from

ApiError.status

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:68

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

ApiError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:52

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

ApiError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ApiError.prepareStackTrace