Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/cosmos

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AggregateType

AggregateType: "Average" | "Count" | "Max" | "Min" | "Sum"

GroupByExpressions

GroupByExpressions: string[]

JSONValue

JSONValue: boolean | number | string | null | JSONArray | JSONObject

PartitionKey

PartitionKey: PartitionKeyDefinition | string | number | {}

SubStatusCode

SubStatusCode: typeof SubStatusCode[keyof typeof SubStatusCode]

TokenProvider

TokenProvider: (requestInfo: RequestInfo) => Promise<string>

Type declaration

    • (requestInfo: RequestInfo): Promise<string>

    • Parameters

      • requestInfo: RequestInfo

      Returns Promise<string>

VerboseOmit

VerboseOmit<T, K>: Pick<T, Exclude<keyof T, K>>

Type parameters

  • T

  • K: keyof any

Variables

Const DEFAULT_PARTITION_KEY_PATH

DEFAULT_PARTITION_KEY_PATH: "/_partitionKey" = "/_partitionKey" as "/_partitionKey"

Const JsonContentType

JsonContentType: "application/json" = "application/json"

Const QueryJsonContentType

QueryJsonContentType: "application/query+json" = "application/query+json"

Const emptyGroup

emptyGroup: "__empty__" = "__empty__"

Const globalCrypto

globalCrypto: Crypto = globalRef.crypto || globalRef.msCrypto

Const globalRef

globalRef: any = typeof self === "undefined" ? window : self

Const illegalResourceIdCharacters

illegalResourceIdCharacters: RegExp = new RegExp("[/\\\\?#]")

Const trimLeftSlashes

trimLeftSlashes: RegExp = new RegExp("^[/]+")

Const trimRightSlashes

trimRightSlashes: RegExp = new RegExp("[/]+$")

Functions

atob

  • atob(str: string): any

bufferToHex

  • bufferToHex(buffer: ArrayBuffer): any

createAggregator

  • createAggregator(aggregateType: AggregateType): AverageAggregator | CountAggregator | MaxAggregator | MinAggregator | SumAggregator | StaticValueAggregator

digest

  • digest(str: string): Promise<any>

encodeBase64

  • encodeBase64(value: ArrayBuffer): string

encodeUTF8

  • encodeUTF8(str: string): Uint8Array

executeRequest

  • executeRequest(requestContext: RequestContext): Promise<Response<any>>

Const extractAggregateResult

  • extractAggregateResult(payload: any): any

generateHeaders

  • generateHeaders(masterKey: string, method: HTTPMethod, resourceType?: ResourceType, resourceId?: string, date?: Date): Promise<{ __computed: string }>

hashObject

  • hashObject(object: any): Promise<any>

hmac

  • hmac(key: string, message: string): Promise<any>

normalizeEndpoint

  • normalizeEndpoint(endpoint: string): string

signature

  • signature(masterKey: string, method: HTTPMethod, resourceType: ResourceType, resourceId?: string, date?: Date): Promise<string>

userAgent

  • userAgent(): string

Generated using TypeDoc