ajv-formats

  • Version 3.0.1
  • Published
  • 56.8 kB
  • 1 dependency
  • MIT license

Install

npm i ajv-formats
yarn add ajv-formats
pnpm add ajv-formats

Overview

Format validation for Ajv v7+

Index

Variables

variable formatsPlugin

const formatsPlugin: FormatsPlugin;

    Interfaces

    interface FormatOptions

    interface FormatOptions {}

      property formats

      formats?: FormatName[];

        property keywords

        keywords?: boolean;

          property mode

          mode?: FormatMode;

            interface FormatsPlugin

            interface FormatsPlugin extends Plugin<FormatsPluginOptions> {}

              property get

              get: (format: FormatName, mode?: FormatMode) => Format;

                Type Aliases

                type FormatMode

                type FormatMode = 'fast' | 'full';

                  type FormatName

                  type FormatName =
                  | 'date'
                  | 'time'
                  | 'date-time'
                  | 'iso-time'
                  | 'iso-date-time'
                  | 'duration'
                  | 'uri'
                  | 'uri-reference'
                  | 'uri-template'
                  | 'url'
                  | 'email'
                  | 'hostname'
                  | 'ipv4'
                  | 'ipv6'
                  | 'regex'
                  | 'uuid'
                  | 'json-pointer'
                  | 'json-pointer-uri-fragment'
                  | 'relative-json-pointer'
                  | 'byte'
                  | 'int32'
                  | 'int64'
                  | 'float'
                  | 'double'
                  | 'password'
                  | 'binary';

                    type FormatsPluginOptions

                    type FormatsPluginOptions = FormatName[] | FormatOptions;

                      type LimitFormatError

                      type LimitFormatError = ErrorObject<
                      Kwd,
                      {
                      limit: string;
                      comparison: Comparison;
                      }
                      >;

                        Package Files (3)

                        Dependencies (1)

                        Dev Dependencies (15)

                        Peer Dependencies (1)

                        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/ajv-formats.

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