Class CallableFunctionBoolean

constructor

• new CallableFunctionBoolean(name, options?): CallableFunctionBoolean

• Parameters

  • name: string

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

  Returns CallableFunctionBoolean

Readonly type

toJSON

• toJSON(): {
      $comment?: string;
      default?: any;
      deprecated?: boolean;
      description?: string;
      examples?: any[];
      readOnly?: boolean;
      title?: string;
      type: "boolean";
      writeOnly?: boolean;
  }

• Serializes the parameter into a JSON object.

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

  • Optional $comment?: string

  • Optional default?: any

  • Optional deprecated?: boolean

  • Optional description?: string

  • Optional examples?: any[]

  • Optional readOnly?: boolean

  • Optional title?: string

  • type: "boolean"

  • Optional writeOnly?: boolean

Static fromJSON

• fromJSON(name, json): CallableFunctionBoolean

• Parameters

  • name: string

  • json: {
        $comment?: string;
        default?: any;
        deprecated?: boolean;
        description?: string;
        examples?: any[];
        readOnly?: boolean;
        title?: string;
        type: "boolean";
        writeOnly?: boolean;
    }

    • Optional $comment?: string

    • Optional default?: any

    • Optional deprecated?: boolean

    • Optional description?: string

    • Optional examples?: any[]

    • Optional readOnly?: boolean

    • Optional title?: string

    • type: "boolean"

    • Optional writeOnly?: boolean

  Returns CallableFunctionBoolean

Static isBooleanSchema

• isBooleanSchema(json): json is {
      $comment?: string;
      default?: any;
      deprecated?: boolean;
      description?: string;
      examples?: any[];
      readOnly?: boolean;
      title?: string;
      type: "boolean";
      writeOnly?: boolean;
  }

• Whether the given JsonSchema is a JsonSchemaBoolean.

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

  Parameters

  • json: JsonSchema

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