Result
type Result = { status: 'ok'; value: *; errors?: ErrorList }| { status: 'fail' | 'fatal'; value?: *; errors: ErrorList; }
The result produced by a parser. This can either be a success or a failure, depending on the values of the properties.
If the result is a success, then status should be Status.Ok and value will have the parsed value and errors will be optional. If the result is a failure, then status should be either Status.Fail or Status.Fatal and value is optional.
This kind of emulates a Either type from Haskell by using status to determine which of value and errors is valid. The other is still legal, but is only used in certain circumstances; for example, errors is used in the 'ok' case only when the parser succeeds despite an underlying parser failing (such as in opt).
Properties
status: The status of the parse result. This indicates whether the parse succeeded, failed, or failed fatally.value: The value returned by the parser on a successful parse.errors: The error list returned by the parser on an unsuccessful parse.