ts-results-es
Version:
A TypeScript implementation of Rust's Result and Option objects.
208 lines • 9.33 kB
JavaScript
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
import { AsyncOption } from './asyncoption.js';
import { Err, Ok } from './result.js';
/**
* An async-aware `Result` counterpart.
*
* Can be combined with asynchronous code without having to ``await`` anything right until
* the moment when you're ready to extract the final ``Result`` out of it.
*
* Can also be combined with synchronous code for convenience.
*/
var AsyncResult = /** @class */ (function () {
/**
* Constructs an `AsyncResult` from a `Result` or a `Promise` of a `Result`.
*
* @example
* ```typescript
* const ar = new AsyncResult(Promise.resolve('value'))
* ```
*/
function AsyncResult(start) {
this.promise = Promise.resolve(start);
}
/**
* Calls `mapper` if the result is `Ok`, otherwise keeps the `Err` value intact.
* This function can be used for control flow based on `Result` values.
*
* @example
* ```typescript
* let goodResult = Ok(1).toAsyncResult()
* let badResult = Err('boo').toAsyncResult()
*
* await goodResult.andThen(async (value) => Ok(value * 2)).promise // Ok(2)
* await goodResult.andThen(async (value) => Err(`${value} is bad`)).promise // Err('1 is bad')
* await badResult.andThen(async (value) => Ok(value * 2)).promise // Err('boo')
* ```
*/
AsyncResult.prototype.andThen = function (mapper) {
var _this = this;
return this.thenInternal(function (result) { return __awaiter(_this, void 0, void 0, function () {
var mapped;
return __generator(this, function (_a) {
if (result.isErr()) {
// SAFETY: What we're returning here is Err<E>. That doesn't sit well with
// TypeScript for some reason, let's explicitly expand the type to what this
// function is supposed to return.
return [2 /*return*/, result];
}
mapped = mapper(result.value);
return [2 /*return*/, mapped instanceof AsyncResult ? mapped.promise : mapped];
});
}); });
};
/**
* Maps an `AsyncResult<T, E>` to `AsyncResult<U, E>` by applying a function to a contained
* `Ok` value, leaving an `Err` value untouched.
*
* This function can be used to compose the results of two functions.
*
* @example
* ```typescript
* let goodResult = Ok(1).toAsyncResult()
* let badResult = Err('boo').toAsyncResult()
*
* await goodResult.map(async (value) => value * 2).promise // Ok(2)
* await badResult.andThen(async (value) => value * 2).promise // Err('boo')
* ```
*/
AsyncResult.prototype.map = function (mapper) {
var _this = this;
return this.thenInternal(function (result) { return __awaiter(_this, void 0, void 0, function () {
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (result.isErr()) {
return [2 /*return*/, result];
}
_a = Ok;
return [4 /*yield*/, mapper(result.value)];
case 1: return [2 /*return*/, _a.apply(void 0, [_b.sent()])];
}
});
}); });
};
/**
* Maps an `AsyncResult<T, E>` to `AsyncResult<T, F>` by applying `mapper` to the `Err` value,
* leaving `Ok` value untouched.
*
* @example
* ```typescript
* let goodResult = Ok(1).toAsyncResult()
* let badResult = Err('boo').toAsyncResult()
*
* await goodResult.mapErr(async (error) => `Error is ${error}`).promise // Ok(1)
* await badResult.mapErr(async (error) => `Error is ${error}`).promise // Err('Error is boo')
* ```
*/
AsyncResult.prototype.mapErr = function (mapper) {
var _this = this;
return this.thenInternal(function (result) { return __awaiter(_this, void 0, void 0, function () {
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (result.isOk()) {
return [2 /*return*/, result];
}
_a = Err;
return [4 /*yield*/, mapper(result.error)];
case 1: return [2 /*return*/, _a.apply(void 0, [_b.sent()])];
}
});
}); });
};
/**
* Returns the value from `other` if this `AsyncResult` contains `Err`, otherwise returns self.
*
* If `other` is a result of a function call consider using `orElse` instead, it will
* only evaluate the function when needed.
*
* @example
* ```
* const badResult = new AsyncResult(Err('Error message'))
* const goodResult = new AsyncResult(Ok(1))
*
* await badResult.or(Ok(123)).promise // Ok(123)
* await goodResult.or(Ok(123)).promise // Ok(1)
* ```
*/
AsyncResult.prototype.or = function (other) {
return this.orElse(function () { return other; });
};
/**
* Returns the value obtained by calling `other` if this `AsyncResult` contains `Err`, otherwise
* returns self.
*
* @example
* ```
* const badResult = new AsyncResult(Err('Error message'))
* const goodResult = new AsyncResult(Ok(1))
*
* await badResult.orElse(() => Ok(123)).promise // Ok(123)
* await goodResult.orElse(() => Ok(123)).promise // Ok(1)
* ```
*/
AsyncResult.prototype.orElse = function (other) {
var _this = this;
return this.thenInternal(function (result) { return __awaiter(_this, void 0, void 0, function () {
var otherValue;
return __generator(this, function (_a) {
if (result.isOk()) {
return [2 /*return*/, result];
}
otherValue = other(result.error);
return [2 /*return*/, otherValue instanceof AsyncResult ? otherValue.promise : otherValue];
});
}); });
};
/**
* Converts from `AsyncResult<T, E>` to `AsyncOption<T>` so that `Err` is converted to `None`
* and `Ok` is converted to `Some`.
*/
AsyncResult.prototype.toOption = function () {
return new AsyncOption(this.promise.then(function (result) { return result.toOption(); }));
};
AsyncResult.prototype.thenInternal = function (mapper) {
return new AsyncResult(this.promise.then(mapper));
};
return AsyncResult;
}());
export { AsyncResult };
//# sourceMappingURL=asyncresult.js.map