next-dipe v0.2.0

next-dipe (next-data-pipe)

Let your data flow in Next.js super easily.

next-dipe is a small lib that wraps up dipe (data-pipe) and provides some additional utilies such as (for example in Next.js by lifting static props).

Why would I need this?

This library works perfectly in combination with the next-data-hooks library.

It works by lifliting up all the boilerplate needed for processing static or server data from props to pre-configured processors callbacks.

Installation 🔧

npm install -S next-dipe

or

yarn add next-dipe

Usage 💡

This library works as an etension of the data-pipe library, and provides some utilities build in for Next.js projects.

// example.config.js
const { LocalFilesPostTask } = require("next-dipe");

const config = {
  articles: {
    processors: [() => {}, LocalFilesPostTask],
  },
};

export default config;

We also expose a useConfig utiltiy used to return a direct link to the config file. To use that function it's necessary to first configure the webpack config to properly resolve the config file previously created.

// next.config.js
const { resolveConfig } = require("next-dipe");
module.exports = {
  webpack: (config, options) => {
    return resolveConfig(config, { configFilePath: "./example.config.js" });
  },
};

And then the actual implementation will look just like:

import { getConfig, runSync } from "next-dipe";

const articles = getConfig("articles");
let { data, errors } = runSync(articles, {});

You can totally skip this part and just use the next-dipe package (as shown below):

import { runSync } from "next-dipe";
let { data, errors } = runSync(
  {
    processors: [],
  },
  {}
);

// or
import config from "../example.config.js";
let { data, errors } = runSync(config.articles, {});

See the example in this repo for some ideas on how to organize your data using preconfigured processors. And check what you can do with the data-pipe package here.