npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@lomray/consistent-suspense

v2.0.5

Published

React library for generate stable ID inside suspense.

Downloads

177

Readme

A suspension that knows where it is

npm GitHub

Quality Gate Status Reliability Rating Security Rating Vulnerabilities Lines of Code Coverage

React useId() doesn't return a stable ID when used inside <Suspense>. This is a huge problem that slows down the development of libraries for concurrent mode in React. Read related issue.

Another problem is the synchronization state of the client and server when streaming html. This package also helps to analyze suspense chunks.

Getting started

The package is distributed using npm, the node package manager.

npm i --save @lomray/consistent-suspense

How to use

import { ConsistentSuspenseProvider, Suspense, useId } from '@lomray/consistent-suspense';

/**
 * 1. Wrap your root component in ConsistentSuspenseProvider
 * 2. Use <Suspense> component from lib
 */
const App: FC = () => {
    const [state] = useState();

    return (
        <ConsistentSuspenseProvider>
          <Suspense fallback={<div>Loading...</div>}>
            <SomeComponent />
          </Suspense>

          { 
              /** in case when we have more then 1 async component inside suspense, 
                we have to use 'NS' wrapper **/ 
          }
          <Suspense fallback={<div>Loading...</div>}>
            <Suspense.NS> { /** this wrapper only for async component **/ }
                <SomeComponent />
            </Suspense.NS>

            <Suspense.NS>
                <SomeComponent />
            </Suspense.NS>
          </Suspense>
        </ConsistentSuspenseProvider>
    )
}

/**
 * 3. Now any components inside ConsistentSuspenseProvider can generate consistent id's
 */
const SomeComponent: FC = () => {
    // this id will be the same between client and server
    const id = useId();
    
    return (
        <div>I'm have the same id on server and client: {id}</div>
    )
}

Analyze suspense html chunks (streaming)

import StreamSuspense from '@lomray/consistent-suspense/server';

app.use('*', (req, res, next) => {
    const suspenseStream = StreamSuspense.create((suspenseId) => {
      // do something
      const anyState = anyStateManager
        .getStateForSuspense(suspenseId)
        .toJSON();

      return `<script>var managerState = ${anyState};</script>`;
    });

  /**
   * then extend write express (or another lib) method
   * analyze html and add 
   */
    const write = res.write.bind(res);
    res.write = (data, ...args): boolean => {
      // be careful, data can be uint8 or string, you need handle it (use Buffer)
      const additionalHtml = suspenseStream.analyze(data);

      return write(data + additionalHtml, ...args) as boolean;
    }
});

Investigate demo app to more understand how it works.

Bugs and feature requests

Bug or a feature request, please open a new issue.

License

Made with 💚

Published under MIT License.