tryError API Documentation v0.0.1-alpha.1

---

tryError API Documentation / isOk

Function: isOk()

function isOk<T, E>(result): result is T;

Defined in: sync.ts:309

Check if a TryResult is successful (not an error) Type predicate that narrows the type

Type Parameters

T

T

E

E extends TryError<string>

Parameters

result

TryResult<T, E>

The result to check

Returns

result is T

True if result is successful

Example

const result = trySync(() => JSON.parse(jsonString));
if (isOk(result)) {
  // result is narrowed to success type
  console.log(result.name);
}