gatsby-plugin-utils
    TypeScript icon, indicating that this package has built-in type declarations

    2.3.0 • Public • Published

    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(),
        })
    
      // 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([`"toVerify" must be a boolean`])
    })

    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
      }
    }

    Keywords

    Install

    npm i gatsby-plugin-utils

    DownloadsWeekly Downloads

    380,965

    Version

    2.3.0

    License

    MIT

    Unpacked Size

    180 kB

    Total Files

    31

    Last publish

    Collaborators

    • dschau
    • kylemathews
    • pieh
    • wardpeet
    • tylerbarnes
    • fk
    • smthomas
    • lekoarts
    • rachelbahl
    • daniellewgatsby
    • veryspry
    • abhiaiyer
    • mxstbr