Skip to main content
Version: 1.x

Interface: ODataFixtures

Standalone OData fixture interface.

Capability​

odata.fixture

Example​

import { odataTest } from 'playwright-praman';

odataTest('query entities', async ({ odata }) => {
  const count = await odata.getEntityCount('/Products/$count');
});

Properties​

odata​

odata: object

callFunctionImport​

readonly callFunctionImport: (serviceUrl, fn, params?, method?, opts?) => Promise<ODataHttpResult<unknown>>

Parameters​
serviceUrl​

string

fn​

string

params?​

Record<string, unknown>

method?​

"POST" | "GET"

opts?​

ODataHttpOptions

Returns​

Promise<ODataHttpResult<unknown>>

createEntity​

readonly createEntity: (serviceUrl, entitySet, data, opts?) => Promise<ODataHttpResult<unknown>>

Parameters​
serviceUrl​

string

entitySet​

string

data​

unknown

opts?​

ODataHttpOptions

Returns​

Promise<ODataHttpResult<unknown>>

deleteEntity​

readonly deleteEntity: (serviceUrl, entitySet, key, opts?) => Promise<void>

Parameters​
serviceUrl​

string

entitySet​

string

key​

string

opts?​

ODataHttpOptions

Returns​

Promise<void>

fetchCSRFToken​

readonly fetchCSRFToken: (serviceUrl) => Promise<CSRFTokenResult>

Parameters​
serviceUrl​

string

Returns​

Promise<CSRFTokenResult>

getEntityCount​

readonly getEntityCount: (path, opts?) => Promise<number>

Parameters​
path​

string

opts?​

ODataOptions

Returns​

Promise<number>

getModelData​

readonly getModelData: (path, opts?) => Promise<unknown>

Parameters​
path​

string

opts?​

ODataOptions

Returns​

Promise<unknown>

getModelProperty​

readonly getModelProperty: (path, opts?) => Promise<unknown>

Parameters​
path​

string

opts?​

ODataOptions

Returns​

Promise<unknown>

hasPendingChanges​

readonly hasPendingChanges: (opts?) => Promise<boolean>

Parameters​
opts?​

ODataOptions

Returns​

Promise<boolean>

queryEntities​

readonly queryEntities: (serviceUrl, entitySet, opts?) => Promise<ODataHttpResult<readonly unknown[]>>

Parameters​
serviceUrl​

string

entitySet​

string

opts?​

ODataQueryOptions

Returns​

Promise<ODataHttpResult<readonly unknown[]>>

updateEntity​

readonly updateEntity: (serviceUrl, entitySet, key, data, opts?) => Promise<ODataHttpResult<unknown>>

Parameters​
serviceUrl​

string

entitySet​

string

key​

string

data​

unknown

opts?​

ODataHttpOptions

Returns​

Promise<ODataHttpResult<unknown>>

waitForLoad​

readonly waitForLoad: (opts?) => Promise<void>

Parameters​
opts?​

WaitForODataLoadOptions

Returns​

Promise<void>