A lightweight library to supercharge the await operator!
Overwait takes your objects and wraps them in a proxy that automatically distributes the await operator down every step during property lookups, function return values, etc.
In practice, overwait takes await a.b.c and turns it into await (await (await a).b).c. The simplest usecase is for fetch:
Old way:
const res = await fetch('https://example.com');
const body = await res.json();Overwait way:
const fetchEasy = overwait(fetch); // only need to do this once
const body = await fetchEach('https://example.com').json();Well no because it's applying await to each level in an object, you can do some crazy things because you'll dig into multiple levels of asynchronous operations:
// Not a specific db library, just an example
const dbAll = overwait(db);
const value = await dbAll.conn('localhost').query('SELECT aColumn FROM MyTable').getRow().aColumn;Above is indentical to doing:
const conn = await db.conn('localhost');
const cursor = await conn.query('SELECT aColumn FROM MyTable');
const row = await cursor.getRow();
const value = await row.aColumn;When using overwait to traverse a property chain, we automatically wrap the this value in functions that are executed as a part of that traversal.
This fact allows you to write code like this:
const getValueFooBar = async function() {
// We don't need concern ourselves if `this`, `foo`, or `bar` are some mix of promises:
return await this.foo.bar;
};Then when using that function in an object, it just works:
const obj = overwait({
foo: Promise.resolve({
bar: Promise.resolve('hi there!')
})
value: getValueFooBar
});
await obj.value(); //=> 'hi there!';