# json-schema-loader

**Repository Path**: mirrors_cloudflare/json-schema-loader

## Basic Information

- **Project Name**: json-schema-loader
- **Description**: Webpack loader that resolves both internal and external JSON Schema references.
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-02-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Json Schema Loader

While still used by the likewise-deprecated `doca` package, for the new `@cloudflare/doca`
package, this package has been replaced by `@cloudflare/json-schema-ref-loader` in
the [json-schema-tools](https://github.com/cloudflare/json-schema-tools) repository.
It relies on several general-purpose JSON Schema utility packages that are also present
in that repository.

Depending on your use case, either this package or the new one may be more suitable.

----

This package is part of the [doca](https://github.com/cloudflare/doca) suite.  Please file any issues at the [doca repository](https://github.com/cloudflare/doca/issues)

## Installation

```
npm install json-schema-loader --save
```

## Description

Webpack loader that resolves both internal and external [json schema](json-schema.org) references (`$ref` properties). The loader uses [json-schema-ref-parser](https://github.com/BigstickCarpet/json-schema-ref-parser) to resolve references. It supports both JSON and YAML. Based on [@pr0da/json-schema-loader](https://github.com/pr0da/json-schema-loader).

## Usage

```js
var resolvedSchema = require('json-schema-loader!./schema.json');
```

Or define it in your `webpack.config.js`

```js
module: {
  loaders: [{
    test: /\.json$/,
    exclude: /node_modules/,
    loader: 'json-schema-loader'
  }]
}
```
```js
var resolvedSchema = require('./schema.json');
```

### Options

#### `useSource: boolean`

This loader normally passes the RefParser the `resourcePath`, not the source.  If you want to chain loaders, make sure to set `useSource=true`.