TodoistSyncError

Thrown when the Sync API accepts a request but one or more of its commands fail.

Sync commands are applied independently, so the commands that succeeded have already taken effect. message, httpStatusCode and responseData describe the first failed command, as on a plain TodoistRequestError, while syncStatus and tempIdMapping cover every command in the request, so callers can tell which ones were applied.

Extends

• TodoistRequestError

Constructors

Constructor

new TodoistSyncError(firstFailure: {
  error: string;
  errorCode: number;
  errorExtra: Record<string, unknown>;
  errorTag: string;
  httpCode: number;
}, __namedParameters: Pick<TodoistSyncError, "syncStatus" | "tempIdMapping">): TodoistSyncError;

Parameters

Parameter	Type
firstFailure	{ error: string; errorCode: number; errorExtra: Record<string, unknown>; errorTag: string; httpCode: number; }
firstFailure.error	string
firstFailure.errorCode	number
firstFailure.errorExtra	Record<string, unknown>
firstFailure.errorTag	string
firstFailure.httpCode	number
__namedParameters	Pick<TodoistSyncError, "syncStatus" | "tempIdMapping">

Returns

TodoistSyncError

Overrides

TodoistRequestError.constructor

Properties

Property	Modifier	Type	Description
httpStatusCode?	public	number	-
message	public	string	-
name	public	string	-
responseData?	public	unknown	-
stack?	public	string	-
syncStatus	public	NonNullable<SyncResponse["syncStatus"]>	Each command's outcome, keyed by the command's uuid: 'ok' or the error it failed with.
tempIdMapping	public	NonNullable<SyncResponse["tempIdMapping"]>	Server IDs assigned to the resources the request created, keyed by the command's tempId.
stackTraceLimit	static	number	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.

Methods

isAuthenticationError()

isAuthenticationError(): boolean;

Returns

boolean

Inherited from

TodoistRequestError.isAuthenticationError

---

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

TodoistRequestError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

TodoistRequestError.prepareStackTrace