deep-awaited

deep-awaited

Tired of nested awaits? Don't like to assign awaited results to intermediate variables? There's finally a solution!

With deep-awaited you can simply chain your calls and get the result with a single line

/* /user/info returns `{ name: "John Doe" }` */
await deepAwaited(fetch("/user/info")).json().name() // resolves to "John Doe"

Library is written in ES6 with provided TypeScript definitions. deep-awaited is based on Proxy so you will need to polyfill it when targeting old browsers.

API

deepAwaited(promise)

The only method exported from the library. It wraps the provided promise so that you could immediately access properties of a value to be resolved.

Limitations

• In order to have a nice chaining, each non-function field is wrapped with a function. Same comes to array elements access. If you use TypeScript, the correct function types will be returned from definitions.
• Literal types are not preserved because of primitives rewrapping

Examples

Access the required field in a fetched json

await deepAwaited(fetch("/user/info")).json().name() // resolves to "John Doe"

Parse strings from the request payload

await deepAwaited(fetch("/user/info")).json().name().split(" ")[0]() // resolves to "John"

Chain asynchronous calls in end-to-end tests (eg Playwright)

import { queries } from 'playwright-testing-library
const findByRole = (...params) => deepAwaited(queries.findByRole(...params))

await findByRole($document, "button").click()