# @react-hook/server-promises

> A React hook for continuously rendering a React tree until no promises are pushed to server-promises's context in a given render.

Latest version **2.0.0** (published 2020-06-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @react-hook/server-promises
pnpm add @react-hook/server-promises
yarn add @react-hook/server-promises
bun add @react-hook/server-promises
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-06-07 |
| First published | 2019-05-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1528 |
| Author | Jared Lunde |
| Maintainers | jaredlunde |
| Keywords | react, react hook, hook, react hooks, hooks |

## Links

- npm: https://www.npmjs.com/package/@react-hook/server-promises
- Repository: https://github.com/jaredLunde/react-hook
- Homepage: https://github.com/jaredLunde/react-hook/tree/master/packages/server-promises#readme
- Issues: https://github.com/jaredLunde/react-hook/issues
- npm.io page: https://npm.io/package/@react-hook/server-promises

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2020-06-07
- 1.0.3 — 2020-06-04
- 1.0.2 — 2019-05-11
- 1.0.1 — 2019-05-11
- 1.0.0 — 2019-05-11

## README

<hr>
<div align="center">
  <h1 align="center">
    useServerPromises()
  </h1>
</div>

<p align="center">
  <a href="https://bundlephobia.com/result?p=@react-hook/server-promises">
    <img alt="Bundlephobia" src="https://img.shields.io/bundlephobia/minzip/@react-hook/server-promises?style=for-the-badge&labelColor=24292e">
  </a>
  <a aria-label="Types" href="https://www.npmjs.com/package/@react-hook/server-promises">
    <img alt="Types" src="https://img.shields.io/npm/types/@react-hook/server-promises?style=for-the-badge&labelColor=24292e">
  </a>
  <!--
  <a aria-label="Code coverage report" href="https://codecov.io/gh/jaredLunde/react-hook">
    <img alt="Code coverage" src="https://img.shields.io/codecov/c/gh/jaredLunde/react-hook?style=for-the-badge&labelColor=24292e">
  </a>
  <a aria-label="Build status" href="https://travis-ci.com/jaredLunde/react-hook">
    <img alt="Build status" src="https://img.shields.io/travis/com/jaredLunde/react-hook?style=for-the-badge&labelColor=24292e">
  </a>
  -->
  <a aria-label="NPM version" href="https://www.npmjs.com/package/@react-hook/server-promises">
    <img alt="NPM Version" src="https://img.shields.io/npm/v/@react-hook/server-promises?style=for-the-badge&labelColor=24292e">
  </a>
  <a aria-label="License" href="https://jaredlunde.mit-license.org/">
    <img alt="MIT License" src="https://img.shields.io/npm/l/@react-hook/server-promises?style=for-the-badge&labelColor=24292e">
  </a>
</p>

<pre align="center">npm i @react-hook/server-promises</pre>
<hr>

A React hook for continuously rendering a React tree until no promises
are pushed to `server-promises`'s context in a given render.

## Quick Start

```jsx harmony
import React from 'react'
import {renderToString} from 'react-dom/server'
import {useServerPromises, loadPromises} from '@react-hook/server-promises'

let LOADED = false
const App = (props) => {
  const serverPromises = useServerPromises()
  // adds a promise to the server promises cache
  const response = useMemo(() => {
    if (LOADED === false) {
      LOADED = true
      return serverPromises.push(fetch('https://github.com'))
    }
  }, [])

  return <span>Status: {response.status}</span>
}

const ServerRenderer = async (props) => `
  <html>
    <body>
      <div id='⚛️'>
        ${await loadPromises(<App />, renderToString)}
      </div>
    </body>
  </html>
`
```

## API

### useServerPromises()

A hook for adding promises to an array of promises you need rendered on the server

#### Returns [`ServerPromisesContextType`](#serverpromisescontexttype)

### ServerPromisesContextType

```ts
export interface ServerPromisesContextType {
  /**
   * An array of promises that are still pending
   */
  promises: Promise<any>[]
  /**
   * Adds a promise to the promises array
   */
  push: (...args: Promise<any>[]) => number
  /**
   * Loads all of the promises currently in the promises array
   */
  load: () => Promise<any>
}
```

### loadPromises(tree, render?, cache?)

Continuously re-renders the React `tree` until there are no promises pending
in a given render

| Argument | Type                                 | Default                               | Required? | Description                                            |
| -------- | ------------------------------------ | ------------------------------------- | --------- | ------------------------------------------------------ |
| tree     | `React.ReactElement`                 | `undefined`                           | Yes       | A React tree to render to string                       |
| render   | `(element: React.ReactElement) => T` | `ReactDOMServer.renderToStaticMarkup` | No        | A server renderer to continuously render the tree with |

#### Returns `string`

## LICENSE

MIT

---
_Source: https://npm.io/package/@react-hook/server-promises · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._