@ib-code/result-object
v1.0.2
Published
Function or method result structure serializer
Downloads
12
Maintainers
Readme
ResultObject
In JavaScript, errors and failures are typically implemented with exceptions. In some situations, however, exceptions may not be the best choice. The ResultObject
contains a build in methods that transform the result to common structure. The ResultObject
object are wrappers for a successful, or failed results of the functions or methods.
Object Sturecture
// SuccessОbject
{
"ok": true,
"data": {
// ...some data
},
"error": undefined,
}
// FailedОbject
{
"ok": false,
"data": {
// ...some data
},
"error": Error // Error object
}
Installation
$ npm install @ib-code/result-object
$ yarn add @ib-code/result-object
Usage
import { Result, ResultObject } from 'result-object'
const someFunctions = (): ResultObject<number> => {
try {
const numebr = getNumber() // example function
return Result.success(numebr)
} catch (error) {
return Result.failed(error, "Additional data")
}
}
Author
License
Copyright (c) 2022 Igor Bezsmertnyi, contributors. Released under the MIT license