Class OData

Private constructor

• new OData(serviceEndpoint, credential?, headers?, fetchProxy?, processCsrfToken?): OData
• Private

  OData

  Parameters

  • serviceEndpoint: string
  • Optional credential: Credential
  • headers: any = {}
  • Optional fetchProxy: FetchProxy
  • processCsrfToken: boolean = false

    auto fetch csrf token before broken operation

  Returns OData

  Deprecated

  please use static method OData.New to create instance

Private commonHeader

Private credential

Private csrfToken

Private csrfTokenName

Private fetchProxy

Private lock

Private oauthClient

Private processCsrfToken

Private serviceEndpoint

Private variant

Private version

Private _executeActionOrFunction

• _executeActionOrFunction(options): any

• Parameters

  • options: ODataActionRequest

  Returns any

• _executeActionOrFunction(options): any

• Parameters

  • options: ODataFunctionRequest

  Returns any

• _executeActionOrFunction(options): any

• Parameters

  • options: ODataFunctionImportRequest

  Returns any

• _executeActionOrFunction(options): any

• Parameters

  • options: ODataActionImportRequest

  Returns any

Private _executeDataOperation

• _executeDataOperation<T>(collection, id?, systemOptions?, method?, entity?): Promise<PlainODataMultiResponse<T>>

• odata request

  Type Parameters

  • T = any

  Parameters

  • collection: string

    CollectionName
  • Optional id: any

    entity uuid or compound key
  • Optional systemOptions: SystemQueryOptions<any>

    query param, not work for single entity uri
  • method: HTTPMethod = "GET"

    request method
  • Optional entity: any

    odata Entity instance

  Returns Promise<PlainODataMultiResponse<T>>

Private formatBatchRequests

• formatBatchRequests(requests): Promise<{
      req: RequestInit;
      url: string;
  }>

• format batch request parameter

  Parameters

  • requests: Promise<BatchRequest<any>>[]

  Returns Promise<{
      req: RequestInit;
      url: string;
  }>

Private formatIdString

• formatIdString(key): string

• convert the odata key predicate object/value to string

  Parameters

  • key: ODataKeyPredicate

  Returns string

  Example

  this.formatIdString(1) // => String('(1)')
  this.formatIdString({UUID:'xxx'}) // => String('(UUID='xxx')')
  Copy

Private getHeaders

• getHeaders(): Promise<{}>

• generate dynamic header

  Returns Promise<{}>

Private requestUri

• requestUri<T>(uri, systemOptions?, method?, body?): Promise<PlainODataMultiResponse<T>>

• odata request uri

  Type Parameters

  • T = any

  Parameters

  • uri: string

    HTTP URI
  • Optional systemOptions: SystemQueryOptions<any>

    odata query params
  • method: HTTPMethod = "GET"

    HTTP method
  • Optional body: any

    request content

  Returns Promise<PlainODataMultiResponse<T>>