KnowledgeOS API Reference
Preparing search index...
api/src
ApiError
Class ApiError
Base error class for all KnowledgeOS errors
Hierarchy (
View Summary
)
KernelError
ApiError
Index
Constructors
constructor
Properties
api
Category
api
Details
category
code
details
documentation
Url
recoverable
retryable
retry
After
Ms
severity
suggestion
timestamp
Methods
to
Api
Error
to
JSON
Constructors
constructor
new
ApiError
(
options
:
ApiErrorOptions
)
:
ApiError
Parameters
options
:
ApiErrorOptions
Returns
ApiError
Properties
Readonly
api
Category
apiCategory
:
ApiErrorCategory
Readonly
api
Details
apiDetails
:
readonly
{
code
:
string
;
expected
:
string
|
null
;
field
:
string
;
message
:
string
;
received
:
string
|
null
;
}
[]
Readonly
category
category
:
ErrorCategory
Readonly
code
code
:
string
Readonly
details
details
:
readonly
ErrorDetail
[]
Readonly
documentation
Url
documentationUrl
:
string
|
null
Readonly
recoverable
recoverable
:
boolean
Readonly
retryable
retryable
:
boolean
Readonly
retry
After
Ms
retryAfterMs
:
number
|
null
Readonly
severity
severity
:
ErrorSeverity
Readonly
suggestion
suggestion
:
string
|
undefined
Readonly
timestamp
timestamp
:
string
Methods
to
Api
Error
toApiError
()
:
ApiError
Returns
ApiError
to
JSON
toJSON
()
:
Record
<
string
,
unknown
>
Returns
Record
<
string
,
unknown
>
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
api
Category
api
Details
category
code
details
documentation
Url
recoverable
retryable
retry
After
Ms
severity
suggestion
timestamp
Methods
to
Api
Error
to
JSON
KnowledgeOS API Reference
Loading...
Base error class for all KnowledgeOS errors