Class CallableFunctionParameter<TModel>Abstract
Hierarchy
- CallableFunctionParameter
Constructors
constructor
- new CallableFunctionParameter<TModel>(name, options?): CallableFunctionParameter<TModel>
-
Type Parameters
-
TModel extends {
$comment?: string;
default?: any;
deprecated?: boolean;
description?: string;
examples?: any[];
readOnly?: boolean;
title?: string;
writeOnly?: boolean;
} = {
$comment?: string;
default?: any;
deprecated?: boolean;
description?: string;
examples?: any[];
readOnly?: boolean;
title?: string;
writeOnly?: boolean;
}
Parameters
-
name: string
-
options: {
$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
Properties
Optional
$comment
$comment?: string
Optional
default
default?: any
Optional
deprecated
deprecated?: boolean
Optional
description
description?: string
Optional
examples
examples?: any[]
Optional
readOnly
readOnly?: boolean
Optional
title
title?: string
Readonly
Abstract
type
type: string
Optional
writeOnly
writeOnly?: boolean
Methods
Abstract
toJSON
- toJSON(): TModel
-
Returns TModel
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
A UUID generated for this parameter by the library.