Class CallableFunctionObject

constructor

• new CallableFunctionObject(name, options?): CallableFunctionObject

• Parameters

  • name: string

  • options: Omit<{
        $comment?: string;
        additionalProperties?: boolean | JsonSchema;
        default?: any;
        deprecated?: boolean;
        description?: string;
        examples?: any[];
        maxProperties?: number;
        minProperties?: number;
        patternProperties?: Record<string, JsonSchema>;
        properties?: Record<string, JsonSchema>;
        readOnly?: boolean;
        required?: string[];
        title?: string;
        type: "object";
        unevaluatedProperties?: boolean;
        writeOnly?: boolean;
    }, "type" | "required" | "properties" | "patternProperties" | "additionalProperties"> = {}

  Returns CallableFunctionObject

Optional additionalProperties

Optional maxProperties

Optional minProperties

Optional patternProperties

Readonly type

Optional unevaluatedProperties

length

• get length(): number

• The number of properties in the object.

  Returns number

addProperty

• addProperty(propertyOrSchema, required?): CallableFunctionObject

• Adds a property to the object.

  Parameters

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

    The property to add or the JsonSchema of the property and its name to add.

  • required: boolean = false

    Whether the property is required.

  Returns CallableFunctionObject

  this

getOptionalProperties

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

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

  All optional properties of the object.

getProperties

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

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

  All properties of the object.

getProperty

• getProperty(name): undefined | CallableFunctionParameter<{
      $comment?: string;
      default?: any;
      deprecated?: boolean;
      description?: string;
      examples?: any[];
      readOnly?: boolean;
      title?: string;
      writeOnly?: boolean;
  }>

• Gets a property by name.

  Parameters

  • name: string

    The name of the property to get.

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

  The property with the given name, or undefined if it does not exist.

getRequiredProperties

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

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

  All required properties of the object.

removeProperty

• removeProperty(name): CallableFunctionObject

• Removes a property by name.

  Parameters

  • name: string

    The name of the property to remove.

  Returns CallableFunctionObject

  this

toJSON

• toJSON(): {
      $comment?: string;
      additionalProperties?: boolean | JsonSchema;
      default?: any;
      deprecated?: boolean;
      description?: string;
      examples?: any[];
      maxProperties?: number;
      minProperties?: number;
      patternProperties?: Record<string, JsonSchema>;
      properties?: Record<string, JsonSchema>;
      readOnly?: boolean;
      required?: string[];
      title?: string;
      type: "object";
      unevaluatedProperties?: boolean;
      writeOnly?: boolean;
  }

• Serializes the parameter into a JSON object.

  Returns {
      $comment?: string;
      additionalProperties?: boolean | JsonSchema;
      default?: any;
      deprecated?: boolean;
      description?: string;
      examples?: any[];
      maxProperties?: number;
      minProperties?: number;
      patternProperties?: Record<string, JsonSchema>;
      properties?: Record<string, JsonSchema>;
      readOnly?: boolean;
      required?: string[];
      title?: string;
      type: "object";
      unevaluatedProperties?: boolean;
      writeOnly?: boolean;
  }

  • Optional $comment?: string

  • Optional additionalProperties?: boolean | JsonSchema

  • Optional default?: any

  • Optional deprecated?: boolean

  • Optional description?: string

  • Optional examples?: any[]

  • Optional maxProperties?: number

  • Optional minProperties?: number

  • Optional patternProperties?: Record<string, JsonSchema>

  • Optional properties?: Record<string, JsonSchema>

  • Optional readOnly?: boolean

  • Optional required?: string[]

  • Optional title?: string

  • type: "object"

  • Optional unevaluatedProperties?: boolean

  • Optional writeOnly?: boolean

Static fromJSON

• fromJSON(name, json): CallableFunctionObject

• Parameters

  • name: string

  • json: {
        $comment?: string;
        additionalProperties?: boolean | JsonSchema;
        default?: any;
        deprecated?: boolean;
        description?: string;
        examples?: any[];
        maxProperties?: number;
        minProperties?: number;
        patternProperties?: Record<string, JsonSchema>;
        properties?: Record<string, JsonSchema>;
        readOnly?: boolean;
        required?: string[];
        title?: string;
        type: "object";
        unevaluatedProperties?: boolean;
        writeOnly?: boolean;
    }

    • Optional $comment?: string

    • Optional additionalProperties?: boolean | JsonSchema

    • Optional default?: any

    • Optional deprecated?: boolean

    • Optional description?: string

    • Optional examples?: any[]

    • Optional maxProperties?: number

    • Optional minProperties?: number

    • Optional patternProperties?: Record<string, JsonSchema>

    • Optional properties?: Record<string, JsonSchema>

    • Optional readOnly?: boolean

    • Optional required?: string[]

    • Optional title?: string

    • type: "object"

    • Optional unevaluatedProperties?: boolean

    • Optional writeOnly?: boolean

  Returns CallableFunctionObject

Static isObjectSchema

• isObjectSchema(json): json is {
      $comment?: string;
      additionalProperties?: boolean | JsonSchema;
      default?: any;
      deprecated?: boolean;
      description?: string;
      examples?: any[];
      maxProperties?: number;
      minProperties?: number;
      patternProperties?: Record<string, JsonSchema>;
      properties?: Record<string, JsonSchema>;
      readOnly?: boolean;
      required?: string[];
      title?: string;
      type: "object";
      unevaluatedProperties?: boolean;
      writeOnly?: boolean;
  }

• Whether the given JsonSchema is a JsonSchemaObject.

  Note: This method does not check if the schema is valid, only if it has properties unique to object schemas.

  Parameters

  • json: JsonSchema

  Returns json is {
      $comment?: string;
      additionalProperties?: boolean | JsonSchema;
      default?: any;
      deprecated?: boolean;
      description?: string;
      examples?: any[];
      maxProperties?: number;
      minProperties?: number;
      patternProperties?: Record<string, JsonSchema>;
      properties?: Record<string, JsonSchema>;
      readOnly?: boolean;
      required?: string[];
      title?: string;
      type: "object";
      unevaluatedProperties?: boolean;
      writeOnly?: boolean;
  }