@sap-cloud-sdk/core/dist/odata-common/selectable/edm-type-field.d.ts

import BigNumber from 'bignumber.js';
import moment from 'moment';
import { EdmTypeShared } from '../edm-types';
import { Entity } from '../entity';
import { Filter } from '../filter';
import { Time } from '../time';
import { ConstructorOrField } from './constructor-or-field';
import { Field, FieldOptions, FieldType } from './field';
/**
 * Convenience type that maps the given [[FieldType]] to a new type that is either nullable or not, depending on the given `NullableT`.
 * @typeparam FieldT - Field type of the field.
 * @typeparam NullableT - Boolean type that represents whether the field is nullable.
 */
declare type NullableFieldType<FieldT extends FieldType, NullableT extends boolean> = NullableT extends true ? FieldT | null : FieldT;
/**
 * Convenience type that maps the given EDM type to a [[FieldType]] without considering whether it is nullable.
 * @typeparam EdmOrFieldT - EDM type of the field. Deprecated: Field type of the field.
 * @typeparam NullableT - Boolean type that represents whether the field is nullable.
 */
declare type NonNullableFieldTypeByEdmType<EdmOrFieldT extends EdmTypeShared<'any'> | FieldType> = EdmOrFieldT extends 'Edm.String' ? string : EdmOrFieldT extends 'Edm.Boolean' ? boolean : EdmOrFieldT extends 'Edm.Decimal' ? BigNumber : EdmOrFieldT extends 'Edm.Double' ? number : EdmOrFieldT extends 'Edm.Single' ? number : EdmOrFieldT extends 'Edm.Float' ? number : EdmOrFieldT extends 'Edm.Int16' ? number : EdmOrFieldT extends 'Edm.Int32' ? number : EdmOrFieldT extends 'Edm.Int64' ? BigNumber : EdmOrFieldT extends 'Edm.SByte' ? number : EdmOrFieldT extends 'Edm.Binary' ? string : EdmOrFieldT extends 'Edm.Guid' ? string : EdmOrFieldT extends 'Edm.Byte' ? number : EdmOrFieldT extends 'Edm.DateTime' ? moment.Moment : EdmOrFieldT extends 'Edm.DateTimeOffset' ? moment.Moment : EdmOrFieldT extends 'Edm.Time' ? Time : EdmOrFieldT extends 'Edm.Date' ? moment.Moment : EdmOrFieldT extends 'Edm.Duration' ? moment.Duration : EdmOrFieldT extends 'Edm.TimeOfDay' ? Time : EdmOrFieldT extends 'Edm.Enum' ? string : EdmOrFieldT extends 'Edm.Any' ? any : EdmOrFieldT extends FieldType ? EdmOrFieldT : never;
/**
 * Convenience type that maps the given EDM type to a [[FieldType]]. It also considers whether the field is nullable.
 * @typeparam EdmOrFieldT - EDM type of the field. Deprecated: Field type of the field.
 * @typeparam NullableT - Boolean type that represents whether the field is nullable.
 */
export declare type FieldTypeByEdmType<EdmOrFieldT extends EdmTypeShared<'any'> | FieldType, NullableT extends boolean> = NullableFieldType<EdmOrFieldT extends EdmTypeShared<'any'> ? NonNullableFieldTypeByEdmType<EdmOrFieldT> : EdmOrFieldT, NullableT>;
/**
 * Convenience type to support legacy `EdmTypeField` with field type as generic parameter.
 * This will become obsolete in the next major version update.
 */
export declare type EdmTypeForEdmOrFieldType<EdmOrFieldT extends EdmTypeShared<'any'> | FieldType> = EdmOrFieldT extends EdmTypeShared<'any'> ? EdmOrFieldT : EdmTypeShared<'any'>;
/**
 * Represents a property of an OData entity with an EDM type.
 *
 * `EdmTypeField`s are used as static properties of entities or EDM typed fields of complex type fields. They are generated from the OData metadata, i.e. for each property of
 * an OData entity, that has an EDM type, there is one static instance of `EdmTypeField` (or rather one of its subclasses) in the corresponding generated class file.
 * `EdmTypeField`s are used to represent the domain of more or less primitive values that can be used in select, filter and order by functions.
 * For example, when constructing a query on the BusinessPartner entity, an instance of `EdmTypeField<BusinessPartner, string>`
 * can be supplied as argument to the select function, e.g. `BusinessPartner.FIRST_NAME`.
 *
 * See also: [[Selectable]]
 * @typeparam EntityT - Type of the entity the field belongs to
 * @typeparam EdmOrFieldT - EDM type of the field. Deprecated: Field type of the field.
 * @typeparam NullableT - Boolean type that represents whether the field is nullable.
 * @typeparam SelectableT - Boolean type that represents whether the field is selectable.
 */
export declare class EdmTypeField<EntityT extends Entity, EdmOrFieldT extends EdmTypeShared<'any'> | FieldType, NullableT extends boolean = false, SelectableT extends boolean = false> extends Field<EntityT, NullableT, SelectableT> {
    readonly _fieldOf: ConstructorOrField<EntityT>;
    readonly edmType: EdmTypeForEdmOrFieldType<EdmOrFieldT>;
    /**
     * Creates an instance of EdmTypeField.
     * @param fieldName - Actual name of the field used in the OData request.
     * @param _fieldOf - Constructor type of the entity the field belongs to.
     * @param edmType - Type of the field according to the metadata description.
     * @param fieldOptions - Optional settings for this field.
     */
    constructor(fieldName: string, _fieldOf: ConstructorOrField<EntityT>, edmType: EdmTypeForEdmOrFieldType<EdmOrFieldT>, fieldOptions?: FieldOptions<NullableT, SelectableT>);
    /**
     * Creates an instance of Filter for this field and the given value using the operator 'eq', i.e. `==`.
     * @param value - Value to be used in the filter
     * @returns The resulting filter
     */
    equals(value: FieldTypeByEdmType<EdmOrFieldT, NullableT>): Filter<EntityT, FieldTypeByEdmType<EdmOrFieldT, NullableT>>;
    /**
     * Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. `!=`.
     * @param value - Value to be used in the filter
     * @returns The resulting filter
     */
    notEquals(value: FieldTypeByEdmType<EdmOrFieldT, NullableT>): Filter<EntityT, FieldTypeByEdmType<EdmOrFieldT, NullableT>>;
    /**
     * Path to the field to be used in filter and order by queries.
     * @returns Path to the field to be used in filter and order by queries.
     */
    fieldPath(): string;
}
export {};
//# sourceMappingURL=edm-type-field.d.ts.map