Class CallableFunctionEnum

Hierarchy

CallableFunctionParameter<JsonSchemaEnum>
- CallableFunctionEnum

Index

Constructors

constructor

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

Properties

`Optional` $comment

$comment?: string

`Optional` default

default?: any

`Optional` deprecated

deprecated?: boolean

`Optional` description

description?: string

enum

enum: (null | string | number | boolean)[]

`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: "enum" = "enum"

Not part of the JSON schema specification

`Optional` writeOnly

writeOnly?: boolean

Methods

toJSON

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

Returns {
    $comment?: string;
    default?: any;
    deprecated?: boolean;
    description?: string;
    enum: (null | string | number | boolean)[];
    examples?: any[];
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}
- Optional $comment?: string
- Optional default?: any
- Optional deprecated?: boolean
- Optional description?: string
- enum: (null | string | number | boolean)[]
- Optional examples?: any[]
- Optional readOnly?: boolean
- Optional title?: string
- Optional writeOnly?: boolean
Overrides CallableFunctionParameter.toJSON
- Defined in packages/lib/src/classes/CallableFunctionParameters/CallableFunctionEnum.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): CallableFunctionEnum
Parameters
- name: string
- json: {
      $comment?: string;
      default?: any;
      deprecated?: boolean;
      description?: string;
      enum: (null | string | number | boolean)[];
      examples?: any[];
      readOnly?: boolean;
      title?: string;
      writeOnly?: boolean;
  }
  - Optional $comment?: string
  - Optional default?: any
  - Optional deprecated?: boolean
  - Optional description?: string
  - enum: (null | string | number | boolean)[]
  - Optional examples?: any[]
  - Optional readOnly?: boolean
  - Optional title?: string
  - Optional writeOnly?: boolean
Returns CallableFunctionEnum
- Defined in packages/lib/src/classes/CallableFunctionParameters/CallableFunctionEnum.ts:23

`Static` isEnumSchema

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

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

Class CallableFunctionEnum

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

enumValues: (null | string | number | boolean)[]

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

Returns CallableFunctionEnum

Properties

Optional $comment

Optional default

Optional deprecated

Optional description

enum

Optional examples

id

name

Optional readOnly

Optional title

Readonly type

Optional writeOnly

Methods

toJSON

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

Optional $comment?: string

Optional default?: any

Optional deprecated?: boolean

Optional description?: string

enum: (null | string | number | boolean)[]

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; default?: any; deprecated?: boolean; description?: string; enum: (null | string | number | boolean)[]; examples?: any[]; readOnly?: boolean; title?: string; writeOnly?: boolean; }

Optional $comment?: string

Optional default?: any

Optional deprecated?: boolean

Optional description?: string

enum: (null | string | number | boolean)[]

Optional examples?: any[]

Optional readOnly?: boolean

Optional title?: string

Optional writeOnly?: boolean

Returns CallableFunctionEnum

Static isEnumSchema

Parameters

json: JsonSchema

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

Settings

Member Visibility

Theme

On This Page

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

`Optional` $comment

`Optional` default

`Optional` deprecated

`Optional` description

`Optional` examples

`Optional` readOnly

`Optional` title

`Readonly` type

`Optional` writeOnly

Returns {
$comment?: string;
default?: any;
deprecated?: boolean;
description?: string;
enum: (null | string | number | boolean)[];
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;
default?: any;
deprecated?: boolean;
description?: string;
enum: (null | string | number | boolean)[];
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` isEnumSchema

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