🇺🇦🇺🇦🇺🇦 Stand with Ukraine 🇺🇦🇺🇦🇺🇦
Eleventy
The possum is Eleventy’s mascot
Eleventy Documentation
Menu
Compare ×4000 file build
Eleventy 1.93s
Next.js 70.65s

JavaScript Data Files

Contents

The following applies to both:

Using JS Data Files Jump to heading

You can export data from a JavaScript file to add data, too. This allows you to execute arbitrary code to fetch data at build time.

module.exports = [
  "user1",
  "user2"
];

If you return a function, we’ll use the return value from that function.

module.exports = function() {
  return [
    "user1",
    "user2"
  ];
};

We use await on the return value, so you can return a promise and/or use an async function, too. Fetch your data asynchronously at build time!

module.exports = function() {
  return new Promise((resolve, reject) => {
    resolve([
      "user1",
      "user2"
    ]);
  });
};
async function fetchUserData(username) {
  // do some async things
  return username;
}

module.exports = async function() {
  let user1 = await fetchUserData("user1");
  let user2 = await fetchUserData("user2");

  return [user1, user2];
};

Fetching data from a remote API Jump to heading

You’ll want to use Eleventy’s Fetch plugin to request and cache data from remote APIs. There is another example on Quick Tip #009—Cache Data Requests.

Arguments to Global Data Files Jump to heading

Added in v1.0.0 When using a callback function in your JavaScript Data Files, Eleventy will now supply any global data already processed via the Configuration API (eleventyConfig.addGlobalData) as well as the eleventy global variable.

module.exports = function(configData) {
  if (configData.eleventy.env.source === "cli") {
    return "I am on the command line";
  }

  return "I am running programmatically via a script";
};

Examples Jump to heading

Example: Using GraphQL Jump to heading

This “Hello World” GraphQL example works out of the box with Eleventy:

const { graphql, buildSchema } = require("graphql");

// this could also be `async function`
module.exports = function() {
  // if you want to `await` for other things here, use `async function`
  var schema = buildSchema(`type Query {
    hello: String
  }`);

  var root = {
    hello: () => "Hello world async!"
  };

  return graphql(schema, "{ hello }", root);
};

Example: Exposing Environment Variables Jump to heading

You can expose environment variables to your templates by utilizing Node.js’ process.env property. (Related: starting in version 1.0, Eleventy supplies a few of its own Environment Variables)

Start by creating a Global Data file (*.js inside of your _data directory) and export the environment variables for use in a template:

Filename _data/myProject.js
module.exports = function() {
  return {
    environment: process.env.MY_ENVIRONMENT || "development"
  };
};

Saving this as myProject.js in your global data directory (by default, this is _data/) gives you access to the myProject.environment variable in your templates.

When MY_ENVIRONMENT is set, the value from myProject.environment will be globally available to be used in your templates. If the variable hasn’t been set, the fallback "development" will be used.

Template Usage Jump to heading

Working from our Inline CSS Quick Tip, we can modify the output to only minify our CSS if we’re building for production:

{% if myProject.environment == "production" %}
<style>{{ css | cssmin | safe }}</style>
{% else %}
<style>{{ css | safe }}</style>
{% endif %}

Other pages in Using Data:

Related Docs