Skip to main content

Class: DocumentTooLargeError

Defined in: packages/agentos/src/cognition/memory/io/ingestion/DocumentTooLargeError.ts:14

Thrown when a document would take more memory to read than its loader allows.

Extends​

  • Error

Constructors​

Constructor​

new DocumentTooLargeError(limit, message?): DocumentTooLargeError

Defined in: packages/agentos/src/cognition/memory/io/ingestion/DocumentTooLargeError.ts:24

Parameters​

limit​

number

The loader's bound, in bytes, on what the document's parts inflate to: the bound a Word file passed, and the office loader's maxInflatedBytes whichever of its bounds the document reached.

message?​

string = ...

What the document reached, when that is another bound: the office loader names the bound officeparser reported. Left out, the message says the document inflates past limit bytes.

Returns​

DocumentTooLargeError

Overrides​

Error.constructor

Properties​

code​

readonly code: "DOCUMENT_TOO_LARGE" = 'DOCUMENT_TOO_LARGE'

Defined in: packages/agentos/src/cognition/memory/io/ingestion/DocumentTooLargeError.ts:16

A stable code for callers that branch on the kind of failure.


limit​

readonly limit: number

Defined in: packages/agentos/src/cognition/memory/io/ingestion/DocumentTooLargeError.ts:24

The loader's bound, in bytes, on what the document's parts inflate to: the bound a Word file passed, and the office loader's maxInflatedBytes whichever of its bounds the document reached.


message​

message: string

Defined in: apps/agentos-live-docs/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

Error.message


name​

name: string

Defined in: apps/agentos-live-docs/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

Error.name


stack?​

optional stack: string

Defined in: apps/agentos-live-docs/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

Error.stack


stackTraceLimit​

static stackTraceLimit: number

Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/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​

Error.stackTraceLimit

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/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​

Error.captureStackTrace


prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/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​

Error.prepareStackTrace