UNPKG

2.67 kBTypeScriptView Raw
1import { EdmTypeShared } from '../../edm-types';
2import { Entity, ODataVersionOf, Constructable } from '../../entity';
3import { ConstructorOrField } from '../constructor-or-field';
4import { EdmTypeField } from '../edm-type-field';
5/**
6 * @deprecated Since v1.47.0. Use [[EdmTypeField]] instead.
7 * Represents a property with a boolean value.
8 * @typeparam EntityT - Type of the entity the field belongs to
9 */
10export declare class BooleanFieldBase<EntityT extends Entity, SelectableT extends boolean = false> extends EdmTypeField<EntityT, boolean, false, SelectableT> {
11}
12/**
13 * @deprecated Since v1.47.0. Use [[EdmTypeField]] instead.
14 * Represents a selectable property with a boolean value.
15 * @typeparam EntityT - Type of the entity the field belongs to
16 */
17export declare class BooleanField<EntityT extends Entity> extends BooleanFieldBase<EntityT, true> {
18}
19/**
20 * @deprecated Since v1.47.0. Use [[EdmTypeField]] instead.
21 * Represents a complex type property with a boolean value.
22 * @typeparam EntityT - Type of the entity the field belongs to
23 */
24export declare class ComplexTypeBooleanPropertyField<EntityT extends Entity, ComplexT = any> extends BooleanFieldBase<EntityT> {
25 /**
26 * The constructor of the entity or the complex type this field belongs to
27 */
28 readonly fieldOf: ConstructorOrField<EntityT, ComplexT>;
29 /**
30 * Creates an instance of ComplexTypeBooleanPropertyField.
31 * @param fieldName - Actual name of the field used in the OData request
32 * @param fieldOf - The constructor of the entity or the complex type this field belongs to
33 * @param edmType - Type of the field according to the metadata description
34 */
35 constructor(fieldName: string, fieldOf: ConstructorOrField<EntityT, ComplexT>, edmType: EdmTypeShared<ODataVersionOf<EntityT>>);
36 /**
37 * @deprecated Since v1.19.0.
38 *
39 * Creates an instance of ComplexTypeBooleanPropertyField.
40 * @param fieldName - Actual name of the field used in the OData request
41 * @param entityConstructor - Constructor type of the entity the field belongs to
42 * @param parentTypeName - Name of the parent complex type
43 * @param edmType - Type of the field according to the metadata description
44 */
45 constructor(fieldName: string, entityConstructor: Constructable<EntityT>, parentTypeName: string, edmType: EdmTypeShared<ODataVersionOf<EntityT>>);
46 /**
47 * Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
48 * @returns Path to the field to be used in filter and order by queries.
49 */
50 fieldPath(): string;
51}
52//# sourceMappingURL=boolean-field.d.ts.map
\No newline at end of file