defer-if v1.0.5

defer-if

defer-if is a utility package that extends the functionality of Remix's defer method, allowing you to easily conditionally defer or not defer data based on some programmatic criteria.

Installation

npm install defer-if

Usage

This is a quick demo showing how to use defer-if to only defer data when the user agent is a mobile device.

import { deferIf } from "defer-if";
import { isMobileUserAgent } from "../your-utils";

export function loader({ request }) {
    const data = {
        value1: await fetchSomething(), // this will always block (never defer)
        value2: "This is a static value",
        value3: fetchSomethingElse(), // this will either block or defer based on `deferIf`
    };

    // Using deferIf
   return await deferIf(data, isMobileUserAgent(request));
}

export default function Component() {
    const data = useLoaderData<typeof loader>();

    return (
        <Suspense fallback="Loading...">
            <Await resolve={data.value3}>
                {(value) => <MyComponent /* ... props */ />}
            </Await>
        </Suspense>
    );
}

Documentation

deferIf accepts three arguments:

1. data: An object containing key-value pairs where values can be Promises or any other values.
2. predicate: A function that returns a boolean value or a boolean value itself. If the function returns true, the promise will be deferred (not awaited); otherwise, it will be awaited (blocking the response).
3. options: An optional configuration object containing:
   • init: A number or ResponseInit value.
   • alwaysAwait: An array of keys that should always be awaited, even if the predicate returns true.
   • neverAwait: An array of keys that should never be awaited, even if the predicate returns false.

Contributing

1. Fork the repository on GitHub.
2. Clone the forked repository to your local machine.
3. Run bun install to install the dependencies.
4. Make your changes or add new features, and ensure that your code follows the existing style and conventions.
5. If you've added new functionality, update the README.md file with relevant information and add tests.
6. Run tests to ensure everything is working as expected.
7. Commit your changes and push them to your forked repository.
8. Create a pull request from your fork to the main repository with a clear and concise description of your changes.

License

This package is released under the MIT License.