UNPKG

1.52 kBTypeScriptView Raw
1import { Constructable, EntityIdentifiable, FieldType, Expandable, GetByKeyRequestBuilder as GetByKeyRequestBuilderBase } from '../../odata-common';
2import { Entity } from '../entity';
3/**
4 * Create an OData request to get a single entity based on its key properties.
5 * The properties available in the response can be restricted by creating a [[GetByKeyRequestBuilderV4.select selection]], where no selection is equal to selecting all fields of the entity.
6 * Navigational properties need to expanded explicitly by [[GetAllRequestBuilderV4.expand]].
7 * where no selection is equal to selecting all fields.
8 * @typeparam EntityT - Type of the entity to be requested
9 */
10export declare class GetByKeyRequestBuilder<EntityT extends Entity> extends GetByKeyRequestBuilderBase<EntityT> implements EntityIdentifiable<EntityT> {
11 readonly _entityConstructor: Constructable<EntityT>;
12 readonly _entity: EntityT;
13 /**
14 * Creates an instance of GetByKeyRequestBuilder.
15 * @param _entityConstructor - Constructor of the entity to create the request for
16 * @param keys - Key-value pairs where the key is the name of a key property of the given entity and the value is the respective value
17 */
18 constructor(_entityConstructor: Constructable<EntityT>, keys: Record<string, FieldType>);
19 expand(expands: Expandable<EntityT>[]): this;
20 expand(...expands: Expandable<EntityT>[]): this;
21}
22export { GetByKeyRequestBuilder as GetByKeyRequestBuilderV4 };
23//# sourceMappingURL=get-by-key-request-builder.d.ts.map
\No newline at end of file