Class MalformedDocumentError

The version matched but the contents did not hold up.

Hierarchy (View Summary)

DocumentParseError
- MalformedDocumentError
  - ReservedChannelError

Index

Constructors

Properties

code documentKind path

Constructors

constructor

new MalformedDocumentError(
    args: {
        code?: "NOT_OBJECT" | "BAD_SHAPE" | "MISSING_FIELD" | "RESERVED_NAME";
        documentKind: DocumentKind;
        message: string;
        path?: string;
    },
): MalformedDocumentError
Parameters
- args: {
      code?: "NOT_OBJECT" | "BAD_SHAPE" | "MISSING_FIELD" | "RESERVED_NAME";
      documentKind: DocumentKind;
      message: string;
      path?: string;
  }
Returns MalformedDocumentError
Overrides DocumentParseError.constructor
- Defined in packages/core/src/model/document-errors.ts:173

Properties

`Readonly`code

code: DocumentErrorCode

`Readonly`documentKind

documentKind: DocumentKind

Which document kind rejected the input.

`Readonly`path

path: string

Slash-path to the offending place, rooted at /. / itself means the whole document.