UNPKG

3.81 kBTypeScriptView Raw
1import { EdmTypeShared } from '../../edm-types';
2import { Entity, ODataVersionOf, Constructable } from '../../entity';
3import { Filter } from '../../filter';
4import { ConstructorOrField } from '../constructor-or-field';
5import { EdmTypeField } from '../edm-type-field';
6/**
7 * @deprecated Since v1.47.0. Use [[OrderableEdmTypeField]] instead.
8 * Represents a property with a number value.
9 * @typeparam EntityT - Type of the entity the field belongs to
10 */
11export declare class NumberFieldBase<EntityT extends Entity, SelectableT extends boolean = false> extends EdmTypeField<EntityT, number, false, SelectableT> {
12 /**
13 * Creates an instance of Filter for this field and the given value using the operator 'gt', i.e. `>`.
14 * @param value - Value to be used in the filter
15 * @returns The resulting filter
16 */
17 greaterThan(value: number): Filter<EntityT, number>;
18 /**
19 * Creates an instance of Filter for this field and the given value using the operator 'ge', i.e. `>=`.
20 * @param value - Value to be used in the filter
21 * @returns The resulting filter
22 */
23 greaterOrEqual(value: number): Filter<EntityT, number>;
24 /**
25 * Creates an instance of Filter for this field and the given value using the operator 'lt', i.e. `<`.
26 * @param value - Value to be used in the filter
27 * @returns The resulting filter
28 */
29 lessThan(value: number): Filter<EntityT, number>;
30 /**
31 * Creates an instance of Filter for this field and the given value using the operator 'le', i.e. `<=`.
32 * @param value - Value to be used in the filter
33 * @returns The resulting filter
34 */
35 lessOrEqual(value: number): Filter<EntityT, number>;
36}
37/**
38 * @deprecated Since v1.47.0. Use [[OrderableEdmTypeField]] instead.
39 * Represents a selectable property with a number value.
40 * @typeparam EntityT - Type of the entity the field belongs to
41 */
42export declare class NumberField<EntityT extends Entity> extends NumberFieldBase<EntityT, true> {
43}
44/**
45 * @deprecated Since v1.47.0. Use [[OrderableEdmTypeField]] instead.
46 * Represents a complex type property with a number value.
47 * @typeparam EntityT - Type of the entity the field belongs to
48 */
49export declare class ComplexTypeNumberPropertyField<EntityT extends Entity, ComplexT = any> extends NumberFieldBase<EntityT> {
50 /**
51 * The constructor of the entity or the complex type this field belongs to
52 */
53 readonly fieldOf: ConstructorOrField<EntityT, ComplexT>;
54 /**
55 * Creates an instance of ComplexTypeNumberPropertyField.
56 * @param fieldName - Actual name of the field used in the OData request
57 * @param fieldOf - The constructor of the entity or the complex type this field belongs to
58 * @param edmType - Type of the field according to the metadata description
59 */
60 constructor(fieldName: string, fieldOf: ConstructorOrField<EntityT, ComplexT>, edmType: EdmTypeShared<ODataVersionOf<EntityT>>);
61 /**
62 * @deprecated Since v1.19.0.
63 *
64 * Creates an instance of ComplexTypeNumberPropertyField.
65 * @param fieldName - Actual name of the field used in the OData request
66 * @param entityConstructor - Constructor type of the entity the field belongs to
67 * @param parentTypeName - Name of the parent complex type
68 * @param edmType - Type of the field according to the metadata description
69 */
70 constructor(fieldName: string, entityConstructor: Constructable<EntityT>, parentTypeName: string, edmType: EdmTypeShared<ODataVersionOf<EntityT>>);
71 /**
72 * Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
73 * @returns Path to the field to be used in filter and order by queries.
74 */
75 fieldPath(): string;
76}
77//# sourceMappingURL=number-field.d.ts.map
\No newline at end of file