npmpackage.info

Gathering detailed insights and metrics for preact-ssr-prepass

Other packages similar to preact-ssr-prepass

next-plugin-preact

3.0.7

Preact plugin for Next.js

react-ssr-prepass

1.6.0

A custom partial React SSR renderer for prefetching and suspense

@plasmicapp/react-ssr-prepass

2.0.8

A custom partial React SSR renderer for prefetching and suspense

preact

10.25.0

Fast 3kb React-compatible Virtual DOM library.

Gathering detailed insights and metrics for preact-ssr-prepass

preact-ssr-prepass

Drop-in replacement for react-ssr-prepass

1.2.2

JavaScript

2,722,674 2.8

Installations

npm install preact-ssr-prepass

Pull Requests

Open

11

Total

52

Closed

9

Merged

32

Issues

Open

3

Total

11

Closed

8

Releases

v1.2.2

Published on 14 Jul 2024

v1.2.1

Published on 21 Nov 2023

1.2.0

v1.2.0

Published on 06 Oct 2021

1.1.3

v1.1.3

Published on 11 Jan 2021

1.1.2

v1.1.2

Published on 14 Oct 2020

1.1.1

v1.1.1

Published on 06 Aug 2020

View all 9 releases

Developer

sventschui

Developer Guide

BETA

Module System

CommonJS, ESM

Min. Node Version

Typescript Support

Yes

Node Version

22.4.0

NPM Version

10.8.1 Statistics

49 Stars

76 Commits

7 Forks

3 Watching

12 Branches

21 Contributors

Updated on 22 Nov 2024

Languages

JavaScript (97.4%)

TypeScript (2.6%)

Total Downloads

Cumulative downloads

Total Downloads

2,722,674

Last day

-22.6%

1,356

Compared to previous day

Last week

-3%

7,656

Compared to previous week

Last month

-9.8%

35,087

Compared to previous month

Last year

-1.3%

616,961

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

preact

Dev Dependencies

@babel/core @babel/preset-env @babel/preset-react babel-eslint babel-jest coveralls flow-bin flow-copy-source flow-typed jest lint-staged microbundle preact preact-render-to-string prettier rimraf typescript

Versions

preact-ssr-prepass

Drop-in replacement for react-ssr-prepass.

Neither Preact nor React support Suspense on the server as of now. Heavily inspired by react-ssr-prepass, preact-ssr-prepass provides a two-pass approach with which Suspense can be used on the server. In the first pass, preact-ssr-prepass will create a VNode tree and await all suspensions, in the second pass preact-render-to-string can be used to render a vnode to a string.

Even if preact-ssr-prepass is designed to do as little as possible, it still adds a slight overhead since the VNode tree is created twice.

⚠️ Note that this is neither an official Preact nor React API and that the way Suspense is handled on the server might/will change in the future!

Usage / API

Awaiting suspensions

preact-ssr-prepass needs to be called just before rendering a vnode to a string. See the following example:

lazy.js:

1export default function LazyLoaded() {
2    return <div>I shall be loaded and rendered on the server</div>
3}

index.js:

1import { createElement as h } from 'preact';
2import { Suspense, lazy } from 'preact/compat';
3import renderToString from 'preact-render-to-string';
4import prepass from 'preact-ssr-prepass';
5
6const LazyComponent = lazy(() => import('./lazy'));
7
8const vnode = (
9    <Suspense fallback={<div>I shall not be rendered on the server</div>}>
10        <LazyComponent />
11    </Suspense>
12);
13
14prepass(vnode)
15    .then(() => {
16        // <div>I shall be loaded and rendered on the server</div>
17        console.log(renderToString(vnode));
18    });

Custom suspensions/data fetching using the visitor

preact-ssr-prepass accepts a second argument that allows you to suspend on arbitrary elements:

1ssrPrepass(<App />, (element, instance) => {
2  if (instance !== undefined && typeof instance.fetchData === 'function') {
3    return instance.fetchData()
4  }
5});

API

1/**
2 * Visitor function to suspend on certain elements.
3 * 
4 * When this function returns a Promise it is awaited before the vnode will be rendered.
5 */
6type Visitor = (element: preact.VNode, instance: ?preact.Component) => ?Promise<any>;
7
8/**
9 * The default export of preact-ssr-prepass
10 *
11 * @param{vnode} preact.VNode The vnode to traverse
12 * @param{visitor} ?Visitor A function that is called for each vnode and might return a Promise to suspend.
13 * @param{context} ?Object Initial context to be used when traversing the vnode tree
14 * @return Promise<any> Promise that will complete once the complete vnode tree is traversed. Note that even if
15 *         a Suspension throws the returned promise will resolve.
16 */
17export default function prepass(vnode: preact.VNode, visitor?: Visitor, context:? Object): Promise<any>;

Replace react-ssr-prepass (e.g. next.js)

react-ssr-prepass is usually used on the server only and not bundled into your bundles but rather required through Node.js. To alias react-ssr-prepass to preact-ssr-prepass we recommend to use module-alias:

Create a file named alias.js:

1const moduleAlias = require('module-alias')
2
3module.exports = () => {
4  moduleAlias.addAlias('react-ssr-prepass', 'preact-ssr-prepass')
5}

Require and execute the exported function in your applications entrypoint (before require'ing react-ssr-prepass):

1require('./alias')();

Differences to `react-ssr-prepass`

The visitor passed to preact-ssr-prepass gets a Preact element instead of a React one. When you use preact/compat's createElement it will make the element/vnode look as similar to a React element as possible.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

6

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to preact-ssr-prepass

preact-ssr-prepass

Installations

Pull Requests

11

52

9

32

Issues

3

11

8

Releases

Developer

sventschui

Developer Guide

CommonJS, ESM

Yes

22.4.0

10.8.1

Statistics

Languages

Total Downloads

2,722,674

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Dev Dependencies

preact-ssr-prepass

Usage / API

Awaiting suspensions

Custom suspensions/data fetching using the visitor

API

Replace react-ssr-prepass (e.g. next.js)

Differences to react-ssr-prepass

10

10

6

0

0

0

0

0

0

0

0

0

0

2.8

/10

Other packages similar to preact-ssr-prepass

Differences to `react-ssr-prepass`