Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.07 KB

ErrorNode.md

File metadata and controls

35 lines (24 loc) · 1.07 KB

ErrorNode

This node defines an error that can be returned by a program.

Diagram

Attributes

Data

Attribute Type Description
kind "errorNode" The node discriminator.
name CamelCaseString The name of the error.
code number The error code.
message string A human-friendly message describing the error.
docs string[] Additional Markdown documentation for the error.

Children

This node has no children.

Functions

errorNode(input)

Helper function that creates a ErrorNode object from an input object.

const node = errorNode({
    name: 'invalidAmountArgument',
    code: 1,
    message: 'The amount argument is invalid.',
});