webpack/schemas/plugins/sharing/ProvideSharedPlugin.json

Packs ECMAScript/CommonJs/AMD modules for the browser. Allows you to split your codebase into multiple bundles, which can be loaded on demand. Supports loaders to preprocess files, i.e. json, jsx, es7, css, less, ... and your custom stuff.

{
  "definitions": {
    "Provides": {
      "description": "Modules that should be provided as shared modules to the share scope. When provided, property name is used to match modules, otherwise this is automatically inferred from share key.",
      "anyOf": [
        {
          "type": "array",
          "items": {
            "description": "Modules that should be provided as shared modules to the share scope.",
            "anyOf": [
              {
                "$ref": "#/definitions/ProvidesItem"
              },
              {
                "$ref": "#/definitions/ProvidesObject"
              }
            ]
          }
        },
        {
          "$ref": "#/definitions/ProvidesObject"
        }
      ]
    },
    "ProvidesConfig": {
      "description": "Advanced configuration for modules that should be provided as shared modules to the share scope.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "eager": {
          "description": "Include the provided module directly instead behind an async request. This allows to use this shared module in initial load too. All possible shared modules need to be eager too.",
          "type": "boolean"
        },
        "exclude": {
          "$ref": "#/definitions/SharedModuleFilter"
        },
        "include": {
          "$ref": "#/definitions/SharedModuleFilter"
        },
        "shareKey": {
          "description": "Key in the share scope under which the shared modules should be stored.",
          "type": "string",
          "minLength": 1
        },
        "shareScope": {
          "description": "Share scope name.",
          "type": "string",
          "minLength": 1
        },
        "version": {
          "description": "Version of the provided module. Will replace lower matching versions, but not higher.",
          "anyOf": [
            {
              "description": "Don't provide a version.",
              "enum": [false]
            },
            {
              "description": "Version as string. Each part of the version should be separated by a dot '.'.",
              "type": "string"
            }
          ]
        }
      }
    },
    "ProvidesItem": {
      "description": "Request to a module that should be provided as shared module to the share scope (will be resolved when relative).",
      "type": "string",
      "minLength": 1
    },
    "ProvidesObject": {
      "description": "Modules that should be provided as shared modules to the share scope. Property names are used as share keys.",
      "type": "object",
      "additionalProperties": {
        "description": "Modules that should be provided as shared modules to the share scope.",
        "anyOf": [
          {
            "$ref": "#/definitions/ProvidesConfig"
          },
          {
            "$ref": "#/definitions/ProvidesItem"
          }
        ]
      }
    },
    "SharedModuleFilter": {
      "description": "Filters shared modules by version or request: with 'include' only matching modules are shared, with 'exclude' matching ones are not. A filtered-out module is resolved and bundled as if it wasn't shared.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "request": {
          "description": "Request remainder after a key ending in a slash (e.g. 'get' for 'lodash/get' under 'lodash/'). Has no effect on other keys.",
          "anyOf": [
            {
              "instanceof": "RegExp",
              "tsType": "RegExp"
            },
            {
              "type": "string",
              "minLength": 1
            }
          ]
        },
        "version": {
          "description": "Version range the module's version (from its description file or the 'version' option) is tested against. A consumed module is tested through its fallback module, so this has no effect on consumes without one.",
          "type": "string",
          "minLength": 1
        }
      },
      "added": "5.112.0"
    }
  },
  "title": "ProvideSharedPluginOptions",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "provides": {
      "$ref": "#/definitions/Provides"
    },
    "shareScope": {
      "description": "Share scope name used for all provided modules (defaults to 'default').",
      "type": "string",
      "minLength": 1
    }
  },
  "required": ["provides"]
}