Class CallableFunctionArray

Hierarchy

CallableFunctionParameter<JsonSchemaArray>
- CallableFunctionArray

Index

Constructors

Properties

$comment? contains? default? deprecated? description? examples? id items? maxContains? maxItems? minContains? minItems? name prefixItems? readOnly? title? type uniqueItems? writeOnly?

Methods

toJSON toJSONBase fromJSON isArraySchema

Constructors

constructor

new CallableFunctionArray(name, options?): CallableFunctionArray
Parameters
- name: string
- options: Omit<{
      $comment?: string;
      contains?: JsonSchema;
      default?: any;
      deprecated?: boolean;
      description?: string;
      examples?: any[];
      items?: boolean | JsonSchema;
      maxContains?: number;
      maxItems?: number;
      minContains?: number;
      minItems?: number;
      prefixItems?: JsonSchema[];
      readOnly?: boolean;
      title?: string;
      type: "array";
      uniqueItems?: boolean;
      writeOnly?: boolean;
  }, "type" | "items"> = {}
Returns CallableFunctionArray
Overrides CallableFunctionParameter.constructor
- Defined in packages/lib/src/classes/CallableFunctionParameters/CallableFunctionArray.ts:22

Properties

`Optional` $comment

$comment?: string

`Optional` contains

contains?: CallableFunctionParameter<{
    $comment?: string;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}>

Type declaration

Optional $comment?: string
Optional default?: any
Optional deprecated?: boolean
Optional description?: string
Optional examples?: any[]
Optional readOnly?: boolean
Optional title?: string
Optional writeOnly?: 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.

`Optional` items

items?: boolean | CallableFunctionParameter<{
    $comment?: string;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}>

`Optional` maxContains

maxContains?: number

`Optional` maxItems

maxItems?: number

`Optional` minContains

minContains?: number

`Optional` minItems

minItems?: number

name

name: string

`Optional` prefixItems

prefixItems?: CallableFunctionParameter<{
    $comment?: string;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}>[]

`Optional` readOnly

readOnly?: boolean

`Optional` title

title?: string

`Readonly` type

type: "array" = "array"

`Optional` uniqueItems

uniqueItems?: boolean

`Optional` writeOnly

writeOnly?: boolean

Methods

toJSON

toJSON(): {
    $comment?: string;
    contains?: JsonSchema;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    items?: boolean | JsonSchema;
    maxContains?: number;
    maxItems?: number;
    minContains?: number;
    minItems?: number;
    prefixItems?: JsonSchema[];
    readOnly?: boolean;
    title?: string;
    type: "array";
    uniqueItems?: boolean;
    writeOnly?: boolean;
}
Serializes the parameter into a JSON object.

Returns {
    $comment?: string;
    contains?: JsonSchema;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    items?: boolean | JsonSchema;
    maxContains?: number;
    maxItems?: number;
    minContains?: number;
    minItems?: number;
    prefixItems?: JsonSchema[];
    readOnly?: boolean;
    title?: string;
    type: "array";
    uniqueItems?: boolean;
    writeOnly?: boolean;
}
- Optional $comment?: string
- Optional contains?: JsonSchema
- Optional default?: any
- Optional deprecated?: boolean
- Optional description?: string
- Optional examples?: any[]
- Optional items?: boolean | JsonSchema
- Optional maxContains?: number
- Optional maxItems?: number
- Optional minContains?: number
- Optional minItems?: number
- Optional prefixItems?: JsonSchema[]
- Optional readOnly?: boolean
- Optional title?: string
- type: "array"
- Optional uniqueItems?: boolean
- Optional writeOnly?: boolean
Overrides CallableFunctionParameter.toJSON
- Defined in packages/lib/src/classes/CallableFunctionParameters/CallableFunctionArray.ts:89

`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): CallableFunctionArray
Parameters
- name: string
- json: {
      $comment?: string;
      contains?: JsonSchema;
      default?: any;
      deprecated?: boolean;
      description?: string;
      examples?: any[];
      items?: boolean | JsonSchema;
      maxContains?: number;
      maxItems?: number;
      minContains?: number;
      minItems?: number;
      prefixItems?: JsonSchema[];
      readOnly?: boolean;
      title?: string;
      type: "array";
      uniqueItems?: boolean;
      writeOnly?: boolean;
  }
  - Optional $comment?: string
  - Optional contains?: JsonSchema
  - Optional default?: any
  - Optional deprecated?: boolean
  - Optional description?: string
  - Optional examples?: any[]
  - Optional items?: boolean | JsonSchema
  - Optional maxContains?: number
  - Optional maxItems?: number
  - Optional minContains?: number
  - Optional minItems?: number
  - Optional prefixItems?: JsonSchema[]
  - Optional readOnly?: boolean
  - Optional title?: string
  - type: "array"
  - Optional uniqueItems?: boolean
  - Optional writeOnly?: boolean
Returns CallableFunctionArray
- Defined in packages/lib/src/classes/CallableFunctionParameters/CallableFunctionArray.ts:34

`Static` isArraySchema

isArraySchema(json): json is {
    $comment?: string;
    contains?: JsonSchema;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    items?: boolean | JsonSchema;
    maxContains?: number;
    maxItems?: number;
    minContains?: number;
    minItems?: number;
    prefixItems?: JsonSchema[];
    readOnly?: boolean;
    title?: string;
    type: "array";
    uniqueItems?: boolean;
    writeOnly?: boolean;
}
Whether the given JsonSchema is a JsonSchemaArray.

Note: This method does not check if the schema is valid, only if it has properties unique to array schemas.
Parameters
- json: JsonSchema
Returns json is {
    $comment?: string;
    contains?: JsonSchema;
    default?: any;
    deprecated?: boolean;
    description?: string;
    examples?: any[];
    items?: boolean | JsonSchema;
    maxContains?: number;
    maxItems?: number;
    minContains?: number;
    minItems?: number;
    prefixItems?: JsonSchema[];
    readOnly?: boolean;
    title?: string;
    type: "array";
    uniqueItems?: boolean;
    writeOnly?: boolean;
}
- Defined in packages/lib/src/classes/CallableFunctionParameters/CallableFunctionArray.ts:85

Class CallableFunctionArray

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

Returns CallableFunctionArray

Properties

Optional $comment

Optional contains

Type declaration

Optional $comment?: string

Optional default?: any

Optional deprecated?: boolean

Optional description?: string

Optional examples?: any[]

Optional readOnly?: boolean

Optional title?: string

Optional writeOnly?: boolean

Optional default

Optional deprecated

Optional description

Optional examples

id

Optional items

Optional maxContains

Optional maxItems

Optional minContains

Optional minItems

name

Optional prefixItems

Optional readOnly

Optional title

Readonly type

Optional uniqueItems

Optional writeOnly

Methods

toJSON

Optional $comment?: string

Optional contains?: JsonSchema

Optional default?: any

Optional deprecated?: boolean

Optional description?: string

Optional examples?: any[]

Optional items?: boolean | JsonSchema

Optional maxContains?: number

Optional maxItems?: number

Optional minContains?: number

Optional minItems?: number

Optional prefixItems?: JsonSchema[]

Optional readOnly?: boolean

Optional title?: string

type: "array"

Optional uniqueItems?: boolean

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

Optional $comment?: string

Optional contains?: JsonSchema

Optional default?: any

Optional deprecated?: boolean

Optional description?: string

Optional examples?: any[]

Optional items?: boolean | JsonSchema

Optional maxContains?: number

`Optional` $comment

`Optional` contains

`Optional` $comment?: string

`Optional` default?: any

`Optional` deprecated?: boolean

`Optional` description?: string

`Optional` examples?: any[]

`Optional` readOnly?: boolean

`Optional` title?: string

`Optional` writeOnly?: boolean

`Optional` default

`Optional` deprecated

`Optional` description

`Optional` examples

`Optional` items

`Optional` maxContains

`Optional` maxItems

`Optional` minContains

`Optional` minItems

`Optional` prefixItems

`Optional` readOnly

`Optional` title

`Readonly` type

`Optional` uniqueItems

`Optional` writeOnly

`Optional` $comment?: string

`Optional` contains?: JsonSchema

`Optional` default?: any

`Optional` deprecated?: boolean

`Optional` description?: string

`Optional` examples?: any[]

`Optional` items?: boolean | JsonSchema

`Optional` maxContains?: number

`Optional` maxItems?: number

`Optional` minContains?: number

`Optional` minItems?: number

`Optional` prefixItems?: JsonSchema[]

`Optional` readOnly?: boolean

`Optional` title?: string

`Optional` uniqueItems?: boolean

`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

`Optional` $comment?: string

`Optional` contains?: JsonSchema

`Optional` default?: any

`Optional` deprecated?: boolean

`Optional` description?: string

`Optional` examples?: any[]

`Optional` items?: boolean | JsonSchema

`Optional` maxContains?: number

`Optional` maxItems?: number

`Optional` minContains?: number

`Optional` minItems?: number

`Optional` prefixItems?: JsonSchema[]

`Optional` readOnly?: boolean

`Optional` title?: string

`Optional` uniqueItems?: boolean

`Optional` writeOnly?: boolean

`Static` isArraySchema