Interface: ODataQueryOptions

Defined in: src/modules/odata-http.ts:71

Query options for entity set retrieval.

Example

const opts: ODataQueryOptions = {
  filter: "Price gt 10",
  select: "Name,Price",
  top: 20,
  skip: 0,
};

Extends

• ODataHttpOptions

Properties

csrfToken?

readonly optional csrfToken: string

Defined in: src/modules/odata-http.ts:53

CSRF token for write operations (POST/PATCH/DELETE).

Inherited from

ODataHttpOptions.csrfToken

---

expand?

readonly optional expand: string

Defined in: src/modules/odata-http.ts:77

OData $expand expression (comma-separated navigation properties).

---

filter?

readonly optional filter: string

Defined in: src/modules/odata-http.ts:73

OData $filter expression.

---

headers?

readonly optional headers: Readonly<Record<string, string>>

Defined in: src/modules/odata-http.ts:55

Additional custom headers to include in the request.

Inherited from

ODataHttpOptions.headers

---

orderby?

readonly optional orderby: string

Defined in: src/modules/odata-http.ts:79

OData $orderby expression.

---

select?

readonly optional select: string

Defined in: src/modules/odata-http.ts:75

OData $select expression (comma-separated property names).

---

skip?

readonly optional skip: number

Defined in: src/modules/odata-http.ts:83

OData $skip value (number of entities to skip).

---

timeout?

readonly optional timeout: number

Defined in: src/modules/odata-http.ts:51

Timeout in ms for the HTTP request.

Inherited from

ODataHttpOptions.timeout

---

top?

readonly optional top: number

Defined in: src/modules/odata-http.ts:81

OData $top value (maximum number of entities to return).