# @kdujs/server-renderer

> @kdujs/server-renderer

Latest version **3.4.27** (published 2024-08-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install @kdujs/server-renderer
pnpm add @kdujs/server-renderer
yarn add @kdujs/server-renderer
bun add @kdujs/server-renderer
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.4.27 |
| Published | 2024-08-30 |
| First published | 2022-07-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 387.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | NKDuy |
| Maintainers | nkduy |
| Keywords | kdu |

## Links

- npm: https://www.npmjs.com/package/@kdujs/server-renderer
- Repository: https://github.com/kdujs/core
- Homepage: https://github.com/kdujs/core/tree/main/packages/server-renderer#readme
- Issues: https://github.com/kdujs/core/issues
- npm.io page: https://npm.io/package/@kdujs/server-renderer

## Dependencies (2)

- [@kdujs/shared](https://npm.io/package/@kdujs/shared.md) 3.4.27
- [@kdujs/compiler-ssr](https://npm.io/package/@kdujs/compiler-ssr.md) 3.4.27

## Recent versions

- 3.4.27 (latest) — 2024-08-30
- 3.4.26 — 2024-08-30
- 3.4.25 — 2024-08-30
- 3.4.24 — 2024-08-30
- 3.4.23 — 2024-08-30
- 3.4.22 — 2024-08-30
- 3.4.21 — 2024-08-30
- 3.4.20 — 2024-08-30
- 3.4.19 — 2024-08-30
- 3.4.18 — 2024-08-30
- 3.4.17 — 2024-08-30
- 3.4.16 — 2024-08-30
- 3.4.15 — 2024-08-30
- 3.4.14 — 2024-08-30
- 3.4.13 — 2024-08-30
- … 50 more at https://npm.io/package/@kdujs/server-renderer/versions

## README

# @kdujs/server-renderer

## Basic API

### `renderToString`

**Signature**

```ts
function renderToString(
  input: App | KNode,
  context?: SSRContext
): Promise<string>
```

**Usage**

```js
const { createSSRApp } = require('kdu')
const { renderToString } = require('@kdujs/server-renderer')

const app = createSSRApp({
  data: () => ({ msg: 'hello' }),
  template: `<div>{{ msg }}</div>`
})

;(async () => {
  const html = await renderToString(app)
  console.log(html)
})()
```

### Handling Teleports

If the rendered app contains teleports, the teleported content will not be part of the rendered string. Instead, they are exposed under the `teleports` property of the ssr context object:

```js
const ctx = {}
const html = await renderToString(app, ctx)

console.log(ctx.teleports) // { '#teleported': 'teleported content' }
```

## Streaming API

### `renderToNodeStream`

Renders input as a [Node.js Readable stream](https://nodejs.org/api/stream.html#stream_class_stream_readable).

**Signature**

```ts
function renderToNodeStream(input: App | KNode, context?: SSRContext): Readable
```

**Usage**

```js
// inside a Node.js http handler
renderToNodeStream(app).pipe(res)
```

**Note:** This method is not supported in the ESM build of `@kdujs/server-renderer`, which is decoupled from Node.js environments. Use `pipeToNodeWritable` instead.

### `pipeToNodeWritable`

Render and pipe to an existing [Node.js Writable stream](https://nodejs.org/api/stream.html#stream_writable_streams) instance.

**Signature**

```ts
function pipeToNodeWritable(
  input: App | KNode,
  context: SSRContext = {},
  writable: Writable
): void
```

**Usage**

```js
// inside a Node.js http handler
pipeToNodeWritable(app, {}, res)
```

### `renderToWebStream`

Renders input as a [Web ReadableStream](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API).

**Signature**

```ts
function renderToWebStream(
  input: App | KNode,
  context?: SSRContext
): ReadableStream
```

**Usage**

```js
// inside an environment with ReadableStream support
return new Response(renderToWebStream(app))
```

**Note:** in environments that do not expose `ReadableStream` constructor in the global scope, `pipeToWebWritable` should be used instead.

### `pipeToWebWritable`

Render and pipe to an existing [Web WritableStream](https://developer.mozilla.org/en-US/docs/Web/API/WritableStream) instance.

**Signature**

```ts
function pipeToWebWritable(
  input: App | KNode,
  context: SSRContext = {},
  writable: WritableStream
): void
```

**Usage**

This is typically used in combination with [`TransformStream`](https://developer.mozilla.org/en-US/docs/Web/API/TransformStream):

```js
// TransformStream is available in environments such as CloudFlare workers.
// in Node.js, TransformStream needs to be explicitly imported from 'stream/web'
const { readable, writable } = new TransformStream()
pipeToWebWritable(app, {}, writable)

return new Response(readable)
```

### `renderToSimpleStream`

Renders input in streaming mode using a simple readable interface.

**Signature**

```ts
function renderToSimpleStream(
  input: App | KNode,
  context: SSRContext,
  options: SimpleReadable
): SimpleReadable

interface SimpleReadable {
  push(content: string | null): void
  destroy(err: any): void
}
```

**Usage**

```js
let res = ''

renderToSimpleStream(
  app,
  {},
  {
    push(chunk) {
      if (chunk === null) {
        // done
        console(`render complete: ${res}`)
      } else {
        res += chunk
      }
    },
    destroy(err) {
      // error encountered
    }
  }
)
```

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