Type Alias SetError<TCategory, TAdditionalType, TAdditionalObj>

Type Declaration

• Optionaldescription?: string | null

  A description of the error to help with debugging that includes an explanation of what the problem was. This is a non-localised string and is not intended to be shown directly to end users.

• { type: SetErrorType<TCategory> | TAdditionalType }

  • type: SetErrorType<TCategory> | TAdditionalType

    The type of error. See JMAP spec for allowed values (e.g. forbidden, overQuota, tooLarge, rateLimit, notFound, invalidPatch, willDestroy, invalidProperties, singleton, etc.)

• TCategory extends "destroy"
      ? never
      : { properties?: string[]; type: "invalidProperties" }
• TAdditionalObj