gatsby-plugin-utils

Usage

npm install gatsby-plugin-utils

`validateOptionsSchema`

The validateOptionsSchema function verifies that the proper data types of options were passed into a plugin from the gatsby-config.js file. It is called internally by Gatsby to validate each plugin's options when a site is started.

Example

import { validateOptionsSchema } from "gatsby-plugin-utils"

await validateOptionsSchema(pluginName, pluginSchema, pluginOptions)

`testPluginOptionsSchema`

Utility to validate and test plugin options schemas. An example of a plugin options schema implementation can be found in the gatsby-node.js file of gatsby-plugin-google-analytics.

Example

// This is an example using Jest (https://jestjs.io/)
import { testPluginOptionsSchema } from "gatsby-plugin-utils"

it(`should partially validate one value of a schema`, async () => {
  const pluginSchema = ({ Joi }) =>
    Joi.object({
      someOtherValue: Joi.string(),
      toVerify: Joi.boolean(),
    })
  const expectedErrors = [`"toVerify" must be a boolean`]

  // Only the "toVerify" key of the schema will be verified in this test
  const { isValid, errors } = await testPluginOptionsSchema(pluginSchema, {
    toVerify: `abcd`,
  })

  expect(isValid).toBe(false)
  expect(errors).toEqual(expectedErrors)
})

`isGatsbyNodeLifecycleSupported`

Utility to be used by plugins to do runtime check against gatsby core package checking wether particular gatsby-node lifecycle API is supported. Useful for plugins to be able to support multiple gatsby core versions.

Example

const { isGatsbyNodeLifecycleSupported } = require(`gatsby-plugin-utils`)

// only use createSchemaCustomization lifecycle only when it's available.
if (isGatsbyNodeLifecycleSupported(`createSchemaCustomization`)) {
  exports.createSchemaCustomization = function createSchemaCustomization({
    actions,
  }) {
    // customize schema
  }
}

`hasFeature`

Feature detection is now part of Gatsby. As a plugin author you don't know what version of Gatsby a user is using. hasFeature allows you to check if the current version of Gatsby has a certain feature.

Here's a list of features: // TODO

Example

const { hasFeature } = require(`gatsby-plugin-utils`)

if (!hasFeature(`image-cdn`)) {
  // You can polyfill image-cdn here so older versions have support as well
}

Add ImageCDN support

Our new ImageCDN allows source plugins to lazily download and process images. if you're a plugin author please use this polyfill to add support for all Gatsby V4 versions.

For more information (see here)[https://gatsby.dev/img]

Example

const {
  addRemoteFilePolyfillInterface,
  polyfillImageServiceDevRoutes,
} = require(`gatsby-plugin-utils/pollyfill-remote-file`)

exports.createSchemaCustomization ({ actions, schema, store }) => {
  actions.createTypes([
    addRemoteFilePolyfillInterface(
      schema.buildObjectType({
        name: `PrefixAsset`,
        fields: {
          // your fields
        },
        interfaces: [`Node`, 'RemoteFile'],
      }),
      {
        schema,
        actions,
        store
      }
    )
  ]);
}

/** @type {import('gatsby').onCreateDevServer} */
exports.onCreateDevServer = ({ app, store }) => {
  polyfillImageServiceDevRoutes(app, store)
}

Current Tags

3.17.0-alpha-9689ff.25 ... alpha-9689ff (2 years ago)
3.17.0-alpha-a5-peer.70 ... alpha-a5-peer (2 years ago)
3.12.0-alpha-mdx-v2.68 ... alpha-mdx-v2 (2 years ago)
1.14.0-alpha-qe-sm.46 ... alpha-qe-sm (3 years ago)
3.8.0-alpha-transformer-json.26 ... alpha-transformer-json (2 years ago)
3.0.0-alpha-ts-jit.26 ... alpha-ts-jit (3 years ago)
4.0.0-alpha-v5.d20221012t101120.57 ... alpha-v5 (2 years ago)
4.13.0-alpha-alt-image-cdn.44 ... alt-image-cdn (a year ago)
0.2.37-dev-ssr-2.17009 ... dev-ssr-2 (4 years ago)
3.11.0-alpha-drupal-image-404.12 ... drupal-image-404 (2 years ago)
4.0.0-alpha-drupal-proxyurl.14 ... drupal-proxyurl (2 years ago)
3.12.0-alpha-drupal-self-reference.18 ... drupal-self-reference (2 years ago)
3.3.0-alpha-image-cdn.68 ... image-cdn (3 years ago)
3.10.0-alpha-image-cdn-caching.9 ... image-cdn-caching (2 years ago)
4.9.0-image-cdn-configurable.4 ... image-cdn-configurable (2 years ago)
3.17.0-alpha-image-cdn-enc.40 ... image-cdn-enc (2 years ago)
3.12.0-alpha-image-cdn-jobs-resolve.32 ... image-cdn-jobs-resolve (2 years ago)
3.19.0-alpha-image-cdn-pathprefix.48 ... image-cdn-pathprefix (2 years ago)
3.7.0-alpha-image-cdn-telemetry.29 ... image-cdn-telemetry (3 years ago)
0.4.0-image-helpers.58 ... image-helpers (4 years ago)
3.2.0-alpha-image-service.35 ... image-service (3 years ago)
4.13.1 ... latest (10 months ago)
1.15.0 ... latest-v3 (2 years ago)
3.19.0 ... latest-v4 (2 years ago)
3.5.0-alpha-luda.30 ... luda (3 years ago)
3.14.0-mdxv4-rc.65 ... mdxv4-rc (2 years ago)
4.14.0-next.2 ... next (10 months ago)
3.17.0-alpha-preview-gh-api.26 ... preview-gh-api (2 years ago)
0.2.27-qod.21 ... qod (4 years ago)
0.2.31-query-modules-debug-missing-sq.23 ... query-webpack-modules (4 years ago)
0.2.36-static-image.17092 ... static-image (4 years ago)
1.0.0-v3rc.0 ... v3rc (4 years ago)
3.18.1-alpha-wordpress-image-err.27 ... wordpress-image-err (2 years ago)
3.9.0-alpha-wp-image-cdn-auth.46 ... wp-image-cdn-auth (2 years ago)

313 Versions

4.13.1 ... 10 months ago
4.14.0-next.2 ... 10 months ago
4.14.0-next.1 ... 10 months ago
4.13.0 ... a year ago
4.14.0-next.0 ... a year ago
4.13.0-next.1 ... a year ago
4.13.0-alpha-alt-image-cdn.44 ... a year ago
4.12.3 ... a year ago
4.12.2 ... a year ago
4.12.1 ... a year ago
4.12.0 ... a year ago
4.13.0-next.0 ... a year ago
4.12.0-next.1 ... a year ago
4.11.0 ... a year ago
4.12.0-next.0 ... a year ago
4.11.0-next.1 ... a year ago
4.10.0 ... a year ago
4.11.0-next.0 ... a year ago
4.10.0-next.2 ... 2 years ago
4.10.0-next.1 ... 2 years ago
4.9.0 ... 2 years ago
4.10.0-next.0 ... 2 years ago
4.9.0-image-cdn-configurable.4 ... 2 years ago
4.9.0-next.1 ... 2 years ago
4.8.0 ... 2 years ago
4.9.0-next.0 ... 2 years ago
4.7.0 ... 2 years ago
4.8.0-next.0 ... 2 years ago
4.6.0 ... 2 years ago
4.7.0-next.0 ... 2 years ago
4.6.0-next.1 ... 2 years ago
4.5.0 ... 2 years ago
4.6.0-next.0 ... 2 years ago
4.5.0-next.1 ... 2 years ago
4.4.0 ... 2 years ago
4.5.0-next.0 ... 2 years ago
4.4.0-next.2 ... 2 years ago
4.3.1 ... 2 years ago
4.4.0-next.1 ... 2 years ago
4.3.0 ... 2 years ago
4.4.0-next.0 ... 2 years ago
1.15.0 ... 2 years ago
3.19.0 ... 2 years ago
4.3.0-next.3 ... 2 years ago
4.3.0-next.2 ... 2 years ago
4.3.0-next.1 ... 2 years ago
4.2.0 ... 2 years ago
4.3.0-next.0 ... 2 years ago
4.0.0-alpha-drupal-proxyurl.14 ... 2 years ago
4.1.0 ... 2 years ago
4.2.0-next.0 ... 2 years ago
3.18.1-alpha-wordpress-image-err.27 ... 2 years ago
3.18.1-alpha-wordpress-image-err.26 ... 2 years ago
3.18.1-alpha-wordpress-image-err.25 ... 2 years ago
4.0.0 ... 2 years ago
4.1.0-next.0 ... 2 years ago
4.0.0-next.4 ... 2 years ago
4.0.0-next.3 ... 2 years ago
4.0.0-next.2 ... 2 years ago
4.0.0-next.1 ... 2 years ago
3.8.0-alpha-transformer-json.26 ... 2 years ago
4.0.0-next.0 ... 2 years ago
4.0.0-alpha-v5.d20221012t101120.57 ... 2 years ago
4.0.0-alpha-v5.d20221010t183635.51 ... 2 years ago
3.19.0-alpha-image-cdn-pathprefix.48 ... 2 years ago
3.19.0-alpha-image-cdn-pathprefix.47 ... 2 years ago
4.0.0-alpha-v5.d20221007t081809.41 ... 2 years ago
4.0.0-alpha-v5.d20221005t111511.35 ... 2 years ago
4.0.0-alpha-v5.16 ... 2 years ago
3.18.0 ... 2 years ago
3.19.0-next.0 ... 2 years ago
3.17.1 ... 2 years ago
3.18.0-next.2 ... 2 years ago
3.18.0-next.1 ... 2 years ago
3.17.0-alpha-image-cdn-enc.40 ... 2 years ago
3.17.0-alpha-a5-peer.70 ... 2 years ago
4.0.0-alpha-v5.26 ... 2 years ago
3.17.0-alpha-image-cdn-enc.23 ... 2 years ago
3.17.0 ... 2 years ago
3.17.0-alpha-preview-gh-api.26 ... 2 years ago
3.18.0-next.0 ... 2 years ago
3.17.0-alpha-v5.26 ... 2 years ago
3.17.0-alpha-9689ff.25 ... 2 years ago
4.0.0-alpha-v5.25 ... 2 years ago
4.0.0-alpha-v5.24 ... 2 years ago
3.16.0 ... 2 years ago
3.17.0-next.0 ... 2 years ago
3.15.0 ... 2 years ago
3.16.0-next.1 ... 2 years ago
3.16.0-next.0 ... 2 years ago
3.15.0-next.2 ... 2 years ago
3.15.0-next.1 ... 2 years ago
3.14.0 ... 2 years ago
3.15.0-next.0 ... 2 years ago
3.14.0-mdxv4-rc.65 ... 2 years ago
3.14.0-next.2 ... 2 years ago
3.14.0-mdxv4-rc.60 ... 2 years ago
3.12.0-mdxv4-rc.76 ... 2 years ago
3.14.0-next.1 ... 2 years ago
3.12.0-alpha-drupal-self-reference.18 ... 2 years ago
3.13.0 ... 2 years ago
3.14.0-next.0 ... 2 years ago
3.12.1 ... 2 years ago
3.12.0-mdxv4-rc.68 ... 2 years ago
3.12.0-alpha-image-cdn-jobs-resolve.32 ... 2 years ago
3.12.0 ... 2 years ago
3.13.0-next.1 ... 2 years ago
3.13.0-next.0 ... 2 years ago
3.12.0-alpha-mdx-v2.68 ... 2 years ago
3.12.0-alpha-mdx-v2.66 ... 2 years ago
3.12.0-next.1 ... 2 years ago
3.11.0 ... 2 years ago
3.12.0-next.0 ... 2 years ago
3.11.0-next.1 ... 2 years ago
3.11.0-alpha-drupal-image-404.12 ... 2 years ago
3.10.0 ... 2 years ago
3.11.0-next.0 ... 2 years ago
3.10.0-alpha-image-cdn-caching.9 ... 2 years ago
3.9.1 ... 2 years ago
3.10.0-next.1 ... 2 years ago
3.9.0 ... 2 years ago
3.9.0-alpha-wp-image-cdn-auth.46 ... 2 years ago
3.9.0-alpha-wp-image-cdn-auth.45 ... 2 years ago
3.9.0-alpha-wp-image-cdn-auth.42 ... 2 years ago
3.10.0-next.0 ... 2 years ago
3.5.0-alpha-luda.30 ... 3 years ago
3.9.0-next.2 ... 3 years ago
3.8.0 ... 3 years ago
3.9.0-next.1 ... 3 years ago
3.9.0-next.0 ... 3 years ago
3.8.0-next.3 ... 3 years ago
3.8.0-next.2 ... 3 years ago
3.7.0 ... 3 years ago
3.8.0-next.1 ... 3 years ago
3.8.0-next.0 ... 3 years ago
3.7.0-alpha-image-cdn-telemetry.29 ... 3 years ago
3.6.1 ... 3 years ago
3.6.0 ... 3 years ago
3.7.0-next.0 ... 3 years ago
3.6.0-next.3 ... 3 years ago
3.6.0-next.2 ... 3 years ago
3.5.1 ... 3 years ago
3.6.0-next.1 ... 3 years ago
3.5.0 ... 3 years ago
3.6.0-next.0 ... 3 years ago
3.5.0-next.3 ... 3 years ago
3.4.2 ... 3 years ago
3.5.0-next.2 ... 3 years ago
3.4.1 ... 3 years ago
3.5.0-next.1 ... 3 years ago
3.4.0 ... 3 years ago
3.5.0-next.0 ... 3 years ago
3.4.0-next.3 ... 3 years ago
3.4.0-next.2 ... 3 years ago
3.4.0-next.1 ... 3 years ago
3.3.0 ... 3 years ago
3.4.0-next.0 ... 3 years ago
3.3.0-alpha-image-cdn.68 ... 3 years ago
3.3.0-alpha-image-cdn.54 ... 3 years ago
3.3.0-alpha-image-cdn.49 ... 3 years ago
3.3.0-alpha-image-cdn.37 ... 3 years ago
3.3.0-alpha-image-cdn.32 ... 3 years ago
3.3.0-alpha-image-cdn.36 ... 3 years ago
3.2.0 ... 3 years ago
3.3.0-alpha-image-service2.14 ... 3 years ago
3.3.0-next.0 ... 3 years ago
3.2.0-next.1 ... 3 years ago
3.2.0-alpha-image-service.54 ... 3 years ago
3.2.0-alpha-image-service.35 ... 3 years ago
3.2.0-alpha-image-service.34 ... 3 years ago
3.2.0-alpha-image-service.33 ... 3 years ago
3.2.0-alpha-image-service.32 ... 3 years ago
3.2.0-alpha-image-service.29 ... 3 years ago
3.2.0-alpha-image-service.26 ... 3 years ago
3.2.0-alpha-image-service.24 ... 3 years ago
3.2.0-alpha-image-service.28 ... 3 years ago
3.2.0-alpha-image-service.27 ... 3 years ago
3.2.0-alpha-image-service.25 ... 3 years ago
3.1.0 ... 3 years ago
3.1.0-alpha-image-service.16 ... 3 years ago
3.1.0-alpha-image-service.15 ... 3 years ago
3.1.0-alpha-image-service.13 ... 3 years ago
3.2.0-next.0 ... 3 years ago
3.1.0-alpha-image-service.14 ... 3 years ago
3.1.0-next.1 ... 3 years ago
3.0.0 ... 3 years ago
3.0.0-alpha-ts-jit.26 ... 3 years ago
3.1.0-next.0 ... 3 years ago
3.0.0-next.0 ... 3 years ago
2.6.0-next.1 [deprecated] ... 3 years ago
2.5.0 ... 3 years ago
2.6.0-next.0 ... 3 years ago
2.5.0-next.1 ... 3 years ago
2.4.0 ... 3 years ago
2.5.0-next.0 ... 3 years ago
2.4.0-next.1 ... 3 years ago
2.3.0 ... 3 years ago
2.4.0-next.0 ... 3 years ago
2.2.0 ... 3 years ago
2.3.0-next.0 ... 3 years ago
2.2.0-next.2 ... 3 years ago
2.1.1 ... 3 years ago
2.2.0-next.1 ... 3 years ago
2.1.0 ... 3 years ago
2.2.0-next.0 ... 3 years ago
2.0.0 ... 3 years ago
2.1.0-next.0 ... 3 years ago
2.0.0-zz-next.3 ... 3 years ago
2.0.0-zz-next.2 ... 3 years ago
1.14.0 ... 3 years ago
2.0.0-zz-next.1 ... 3 years ago
2.0.0-zz-next.8 ... 3 years ago
2.0.0-next.1 ... 3 years ago
2.0.0-next.0 ... 3 years ago
2.0.0-alpha-9689ff.13 ... 3 years ago
1.14.0-alpha-qe-sm.46 ... 3 years ago
2.0.0-alpha-9689ff.36 ... 3 years ago
2.0.0-alpha-9689ff.34 ... 3 years ago
2.0.0-alpha-9689ff.24 ... 3 years ago
2.0.0-alpha-9689ff.22 ... 3 years ago
2.0.0-alpha-9689ff.17 ... 3 years ago
2.0.0-alpha-9689ff.8 ... 3 years ago
1.14.0-next.2 ... 3 years ago
1.14.0-next.1 ... 3 years ago
1.11.0-alpha-qe-sm.108 ... 3 years ago
1.13.0 ... 3 years ago
2.0.0-alpha-9689ff.5 ... 3 years ago
1.14.0-next.0 ... 3 years ago
1.11.0-alpha-qe-sm.86 ... 3 years ago
1.11.0-alpha-qe-sm.85 ... 3 years ago
1.11.0-alpha-qe-sm.83 ... 3 years ago
2.0.0-alpha-9689ff.27 ... 3 years ago
1.12.0 ... 3 years ago
1.13.0-next.0 ... 3 years ago
1.12.0-next.3 ... 3 years ago
1.12.0-next.2 ... 3 years ago
1.12.0-next.1 ... 3 years ago
1.11.0 ... 3 years ago
1.12.0-next.0 ... 3 years ago
1.10.0 ... 3 years ago
1.11.0-next.0 ... 3 years ago
1.10.0-next.1 ... 3 years ago
1.9.0 ... 3 years ago
1.10.0-next.0 ... 3 years ago
1.9.0-next.1 ... 3 years ago
1.8.0 ... 3 years ago
1.9.0-next.0 ... 3 years ago
1.7.1 ... 3 years ago
1.8.0-next.1 ... 3 years ago
1.7.0 ... 3 years ago
1.8.0-next.0 ... 3 years ago
1.7.0-next.2 ... 3 years ago
1.7.0-next.1 ... 3 years ago
1.6.0 ... 3 years ago
1.7.0-next.0 ... 3 years ago
1.5.0 ... 4 years ago
1.6.0-next.0 ... 4 years ago
1.4.0 ... 4 years ago
1.5.0-next.0 ... 4 years ago
1.3.0 ... 4 years ago
1.4.0-next.0 ... 4 years ago
1.3.0-next.1 ... 4 years ago
1.2.0 ... 4 years ago
1.3.0-next.0 ... 4 years ago
1.1.0 ... 4 years ago
1.2.0-next.0 ... 4 years ago
1.0.0 ... 4 years ago
1.0.0-v3rc.0 ... 4 years ago
1.1.0-next.1 ... 4 years ago
1.1.0-next.0 ... 4 years ago
1.0.0-next.1 ... 4 years ago
1.0.0-next.0 ... 4 years ago
0.9.0 ... 4 years ago
0.10.0-next.0 ... 4 years ago
0.8.0 ... 4 years ago
0.9.0-next.0 ... 4 years ago
0.8.0-next.1 ... 4 years ago
0.7.0 ... 4 years ago
0.8.0-next.0 ... 4 years ago
0.7.0-next.1 ... 4 years ago
0.6.0 ... 4 years ago
0.7.0-next.0 ... 4 years ago
0.5.0 ... 4 years ago
0.6.0-next.0 ... 4 years ago
0.4.0-image-helpers.58 ... 4 years ago
0.4.0 ... 4 years ago
0.5.0-next.0 ... 4 years ago
0.3.0 ... 4 years ago
0.4.0-next.0 ... 4 years ago
0.3.0-next.1 ... 4 years ago
0.3.0-next.0 ... 4 years ago
0.2.40 ... 4 years ago
0.2.39 ... 4 years ago
0.2.27-qod.21 ... 4 years ago
0.2.27-qod.20 ... 4 years ago
0.2.36-static-image.17092 ... 4 years ago
0.2.38 ... 4 years ago
0.2.27-qod.19 ... 4 years ago
0.2.37 ... 4 years ago
0.2.37-dev-ssr-2.17009 ... 4 years ago
0.2.36 ... 4 years ago
0.2.35 ... 4 years ago
0.2.29-dev-ssr-2.16931 ... 4 years ago
0.2.34 ... 4 years ago
0.2.33 ... 4 years ago
0.2.32 ... 4 years ago
0.2.31 ... 4 years ago
0.2.31-query-modules-debug-missing-sq.23 ... 4 years ago
0.2.30 ... 4 years ago
0.2.29 ... 4 years ago
0.2.28 ... 4 years ago
0.2.27 ... 4 years ago
0.2.26 ... 4 years ago