Logo for jsDocs.io

json-schema-traverse

  • Version 1.0.0
  • Published
  • 22.2 kB
  • No dependencies
  • MIT license

Install

npm i json-schema-traverse
yarn add json-schema-traverse
pnpm add json-schema-traverse

Overview

Traverse JSON Schema passing each schema object to callback

Index

Functions

Interfaces

Type Aliases

Functions

function traverse

traverse: {
    (
        schema: traverse.SchemaObject,
        opts: traverse.Options,
        cb?: traverse.Callback
    ): void;
    (schema: traverse.SchemaObject, cb: traverse.Callback): void;
};

    Interfaces

    interface Options

    interface Options {}

      property allKeys

      allKeys?: boolean;

        property cb

        cb?:
            | Callback
            | {
                  pre?: Callback;
                  post?: Callback;
              };

          interface SchemaObject

          interface SchemaObject {}

            property $id

            $id?: string;

              property $schema

              $schema?: string;

                index signature

                [x: string]: any;

                  Type Aliases

                  type Callback

                  type Callback = (
                      schema: SchemaObject,
                      jsonPtr: string,
                      rootSchema: SchemaObject,
                      parentJsonPtr?: string,
                      parentKeyword?: string,
                      parentSchema?: SchemaObject,
                      keyIndex?: string | number
                  ) => void;

                    Package Files (1)

                    Dependencies (0)

                    No dependencies.

                    Dev Dependencies (4)

                    Peer Dependencies (0)

                    No peer dependencies.

                    Badge

                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/json-schema-traverse.

                    • Markdown
                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/json-schema-traverse)
                    • HTML
                      <a href="https://www.jsdocs.io/package/json-schema-traverse"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>