Class CallableFunctionConst

Hierarchy

CallableFunctionParameter<JsonSchemaConst>
- CallableFunctionConst

Index

Constructors

constructor

new CallableFunctionConst(name, constValues, options?): CallableFunctionConst
Parameters
- name: string
- constValues: null | string | number | boolean
- options: Omit<{
      $comment?: string;
      const: null | string | number | boolean;
      default?: any;
      deprecated?: boolean;
      description?: string;
      examples?: any[];
      readOnly?: boolean;
      title?: string;
      writeOnly?: boolean;
  }, "const"> = {}
Returns CallableFunctionConst
Overrides CallableFunctionParameter.constructor
- Defined in packages/lib/src/classes/CallableFunctionParameters/CallableFunctionConst.ts:14

Properties

`Optional` $comment

$comment?: string

const

const: null | string | number | boolean

`Optional` default

default?: any

`Optional` deprecated

deprecated?: boolean

`Optional` description

description?: string

`Optional` examples

examples?: any[]

id

id: string = ...

A UUID generated for this parameter by the library.

name

name: string

`Optional` readOnly

readOnly?: boolean

`Optional` title

title?: string

`Readonly` type

type: "const" = "const"

Not part of the JSON schema specification

`Optional` writeOnly

writeOnly?: boolean

Methods

toJSON

toJSON(): {
    $comment?: string;
    const: null | string | number | boolean;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}
Serializes the parameter into a JSON object.

Returns {
    $comment?: string;
    const: null | string | number | boolean;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}
- Optional $comment?: string
- const: null | string | number | boolean
- Optional default?: any
- Optional deprecated?: boolean
- Optional description?: string
- Optional examples?: any[]
- Optional readOnly?: boolean
- Optional title?: string
- Optional writeOnly?: boolean
Overrides CallableFunctionParameter.toJSON
- Defined in packages/lib/src/classes/CallableFunctionParameters/CallableFunctionConst.ts:45

`Protected` toJSONBase

toJSONBase(): {
    $comment?: string;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}
Returns {
    $comment?: string;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}
- Optional $comment?: string
- Optional default?: any
- Optional deprecated?: boolean
- Optional description?: string
- Optional examples?: any[]
- Optional readOnly?: boolean
- Optional title?: string
- Optional writeOnly?: boolean
Inherited from CallableFunctionParameter.toJSONBase
- Defined in packages/lib/src/classes/CallableFunctionParameters/CallableFunctionParameter.ts:46

`Static` fromJSON

fromJSON(name, json): CallableFunctionConst
Parameters
- name: string
- json: {
      $comment?: string;
      const: null | string | number | boolean;
      default?: any;
      deprecated?: boolean;
      description?: string;
      examples?: any[];
      readOnly?: boolean;
      title?: string;
      writeOnly?: boolean;
  }
  - Optional $comment?: string
  - const: null | string | number | boolean
  - Optional default?: any
  - Optional deprecated?: boolean
  - Optional description?: string
  - Optional examples?: any[]
  - Optional readOnly?: boolean
  - Optional title?: string
  - Optional writeOnly?: boolean
Returns CallableFunctionConst
- Defined in packages/lib/src/classes/CallableFunctionParameters/CallableFunctionConst.ts:23

`Static` isConstSchema

isConstSchema(json): json is {
    $comment?: string;
    const: null | string | number | boolean;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}
Whether the given JsonSchema is a JsonSchemaConst.

Note: This method does not check if the schema is valid, only if it has properties unique to const schemas.
Parameters
- json: JsonSchema
Returns json is {
    $comment?: string;
    const: null | string | number | boolean;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}
- Defined in packages/lib/src/classes/CallableFunctionParameters/CallableFunctionConst.ts:41

Class CallableFunctionConst

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

constValues: null | string | number | boolean

options: Omit<{ $comment?: string; const: null | string | number | boolean; default?: any; deprecated?: boolean; description?: string; examples?: any[]; readOnly?: boolean; title?: string; writeOnly?: boolean; }, "const"> = {}

Returns CallableFunctionConst

Properties

Optional $comment

const

Optional default

Optional deprecated

Optional description

Optional examples

id

name

Optional readOnly

Optional title

Readonly type

Optional writeOnly

Methods

toJSON

Returns { $comment?: string; const: null | string | number | boolean; default?: any; deprecated?: boolean; description?: string; examples?: any[]; readOnly?: boolean; title?: string; writeOnly?: boolean; }

Optional $comment?: string

const: null | string | number | boolean

Optional default?: any

Optional deprecated?: boolean

Optional description?: string

Optional examples?: any[]

Optional readOnly?: boolean

Optional title?: string

Optional writeOnly?: boolean

Protected toJSONBase

Returns { $comment?: string; default?: any; deprecated?: boolean; description?: string; examples?: any[]; readOnly?: boolean; title?: string; writeOnly?: boolean; }

Optional $comment?: string

Optional default?: any

Optional deprecated?: boolean

Optional description?: string

Optional examples?: any[]

Optional readOnly?: boolean

Optional title?: string

Optional writeOnly?: boolean

Static fromJSON

Parameters

name: string

json: { $comment?: string; const: null | string | number | boolean; default?: any; deprecated?: boolean; description?: string; examples?: any[]; readOnly?: boolean; title?: string; writeOnly?: boolean; }

Optional $comment?: string

const: null | string | number | boolean

Optional default?: any

Optional deprecated?: boolean

Optional description?: string

Optional examples?: any[]

Optional readOnly?: boolean

Optional title?: string

Optional writeOnly?: boolean

Returns CallableFunctionConst

Static isConstSchema

Parameters

json: JsonSchema

Returns json is { $comment?: string; const: null | string | number | boolean; default?: any; deprecated?: boolean; description?: string; examples?: any[]; readOnly?: boolean; title?: string; writeOnly?: boolean; }

Settings

Member Visibility

Theme

On This Page

options: Omit<{
$comment?: string;
const: null | string | number | boolean;
default?: any;
deprecated?: boolean;
description?: string;
examples?: any[];
readOnly?: boolean;
title?: string;
writeOnly?: boolean;
}, "const"> = {}

`Optional` $comment

`Optional` default

`Optional` deprecated

`Optional` description

`Optional` examples

`Optional` readOnly

`Optional` title

`Readonly` type

`Optional` writeOnly

Returns {
$comment?: string;
const: null | string | number | boolean;
default?: any;
deprecated?: boolean;
description?: string;
examples?: any[];
readOnly?: boolean;
title?: string;
writeOnly?: boolean;
}

`Optional` $comment?: string

`Optional` default?: any

`Optional` deprecated?: boolean

`Optional` description?: string

`Optional` examples?: any[]

`Optional` readOnly?: boolean

`Optional` title?: string

`Optional` writeOnly?: boolean

`Protected` toJSONBase

Returns {
$comment?: string;
default?: any;
deprecated?: boolean;
description?: string;
examples?: any[];
readOnly?: boolean;
title?: string;
writeOnly?: boolean;
}

`Optional` $comment?: string

`Optional` default?: any

`Optional` deprecated?: boolean

`Optional` description?: string

`Optional` examples?: any[]

`Optional` readOnly?: boolean

`Optional` title?: string

`Optional` writeOnly?: boolean

`Static` fromJSON

json: {
$comment?: string;
const: null | string | number | boolean;
default?: any;
deprecated?: boolean;
description?: string;
examples?: any[];
readOnly?: boolean;
title?: string;
writeOnly?: boolean;
}

`Optional` $comment?: string

`Optional` default?: any

`Optional` deprecated?: boolean

`Optional` description?: string

`Optional` examples?: any[]

`Optional` readOnly?: boolean

`Optional` title?: string

`Optional` writeOnly?: boolean

`Static` isConstSchema

Returns json is {
$comment?: string;
const: null | string | number | boolean;
default?: any;
deprecated?: boolean;
description?: string;
examples?: any[];
readOnly?: boolean;
title?: string;
writeOnly?: boolean;
}