@sap-cloud-sdk/core
Version:
SAP Cloud SDK for JavaScript core
77 lines • 3.81 kB
TypeScript
import { EdmTypeShared } from '../../edm-types';
import { Entity, ODataVersionOf, Constructable } from '../../entity';
import { Filter } from '../../filter';
import { ConstructorOrField } from '../constructor-or-field';
import { EdmTypeField } from '../edm-type-field';
/**
* @deprecated Since v1.47.0. Use [[OrderableEdmTypeField]] instead.
* Represents a property with a number value.
* @typeparam EntityT - Type of the entity the field belongs to
*/
export declare class NumberFieldBase<EntityT extends Entity, SelectableT extends boolean = false> extends EdmTypeField<EntityT, number, false, SelectableT> {
/**
* Creates an instance of Filter for this field and the given value using the operator 'gt', i.e. `>`.
* @param value - Value to be used in the filter
* @returns The resulting filter
*/
greaterThan(value: number): Filter<EntityT, number>;
/**
* Creates an instance of Filter for this field and the given value using the operator 'ge', i.e. `>=`.
* @param value - Value to be used in the filter
* @returns The resulting filter
*/
greaterOrEqual(value: number): Filter<EntityT, number>;
/**
* Creates an instance of Filter for this field and the given value using the operator 'lt', i.e. `<`.
* @param value - Value to be used in the filter
* @returns The resulting filter
*/
lessThan(value: number): Filter<EntityT, number>;
/**
* Creates an instance of Filter for this field and the given value using the operator 'le', i.e. `<=`.
* @param value - Value to be used in the filter
* @returns The resulting filter
*/
lessOrEqual(value: number): Filter<EntityT, number>;
}
/**
* @deprecated Since v1.47.0. Use [[OrderableEdmTypeField]] instead.
* Represents a selectable property with a number value.
* @typeparam EntityT - Type of the entity the field belongs to
*/
export declare class NumberField<EntityT extends Entity> extends NumberFieldBase<EntityT, true> {
}
/**
* @deprecated Since v1.47.0. Use [[OrderableEdmTypeField]] instead.
* Represents a complex type property with a number value.
* @typeparam EntityT - Type of the entity the field belongs to
*/
export declare class ComplexTypeNumberPropertyField<EntityT extends Entity, ComplexT = any> extends NumberFieldBase<EntityT> {
/**
* The constructor of the entity or the complex type this field belongs to
*/
readonly fieldOf: ConstructorOrField<EntityT, ComplexT>;
/**
* Creates an instance of ComplexTypeNumberPropertyField.
* @param fieldName - Actual name of the field used in the OData request
* @param fieldOf - The constructor of the entity or the complex type this field belongs to
* @param edmType - Type of the field according to the metadata description
*/
constructor(fieldName: string, fieldOf: ConstructorOrField<EntityT, ComplexT>, edmType: EdmTypeShared<ODataVersionOf<EntityT>>);
/**
* @deprecated Since v1.19.0.
*
* Creates an instance of ComplexTypeNumberPropertyField.
* @param fieldName - Actual name of the field used in the OData request
* @param entityConstructor - Constructor type of the entity the field belongs to
* @param parentTypeName - Name of the parent complex type
* @param edmType - Type of the field according to the metadata description
*/
constructor(fieldName: string, entityConstructor: Constructable<EntityT>, parentTypeName: string, edmType: EdmTypeShared<ODataVersionOf<EntityT>>);
/**
* Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
* @returns Path to the field to be used in filter and order by queries.
*/
fieldPath(): string;
}
//# sourceMappingURL=number-field.d.ts.map