Search
Preparing search index...
The search index is not available
Back To Index
|
@azure/cosmos
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
@azure/cosmos
Package version
Index
Enumerations
Conflict
Resolution
Mode
Connection
Mode
Consistency
Level
Data
Type
Index
Kind
Indexing
Mode
Permission
Mode
Trigger
Operation
Trigger
Type
User
Defined
Function
Type
Classes
Change
Feed
Iterator
Change
Feed
Response
Client
Side
Metrics
Conflict
Conflict
Response
Conflicts
Container
Container
Response
Containers
Cosmos
Client
Database
Database
Account
Database
Response
Databases
Feed
Response
Item
Item
Response
Items
Offer
Offer
Response
Offers
Permission
Permission
Response
Permissions
Query
Iterator
Query
Metrics
Query
Preparation
Times
Resource
Response
Runtime
Execution
Times
Scripts
Stored
Procedure
Stored
Procedure
Response
Stored
Procedures
Timeout
Error
Trigger
Trigger
Response
Triggers
User
User
Defined
Function
User
Defined
Function
Response
User
Defined
Functions
User
Response
Users
Interfaces
Agent
Change
Feed
Options
Conflict
Definition
Conflict
Resolution
Policy
Connection
Policy
Container
Definition
Container
Request
Cosmos
Client
Options
Cosmos
Headers
Database
Definition
Database
Request
Document
Error
Response
Feed
Options
Index
Indexed
Path
Indexing
Policy
Item
Definition
JSONArray
JSONObject
Location
Min
Aggregate
Result
Offer
Definition
Partition
Key
Definition
Permission
Body
Permission
Definition
Request
Options
Resource
Retry
Context
Retry
Options
Shared
Options
Sql
Parameter
Sql
Query
Spec
Stored
Procedure
Definition
Trigger
Definition
Unique
Key
Unique
Key
Policy
User
Defined
Function
Definition
User
Definition
Type aliases
JSONValue
Partition
Key
Sub
Status
Code
Token
Provider
Variables
DEFAULT_
PARTITION_
KEY_
PATH
Functions
atob
digest
encode
Base64
encodeUTF8
generate
Headers
hmac
Type aliases
JSONValue
JSONValue
:
boolean
|
number
|
string
|
null
|
JSONArray
|
JSONObject
Partition
Key
Partition
Key
:
PartitionKeyDefinition
|
string
|
number
|
__type
Sub
Status
Code
Sub
Status
Code
:
number
Token
Provider
Token
Provider
:
function
Type declaration
(
requestInfo
:
RequestInfo
)
:
Promise
<
string
>
Parameters
requestInfo:
RequestInfo
Returns
Promise
<
string
>
Variables
Const
DEFAULT_
PARTITION_
KEY_
PATH
DEFAULT_
PARTITION_
KEY_
PATH
:
"/_partitionKey"
= "/_partitionKey" as "/_partitionKey"
Functions
atob
atob
(
str
:
string
)
:
string
Parameters
str:
string
Returns
string
digest
digest
(
str
:
string
)
:
Promise
<
string
>
Parameters
str:
string
Returns
Promise
<
string
>
encode
Base64
encode
Base64
(
value
:
ArrayBuffer
)
:
string
Parameters
value:
ArrayBuffer
Returns
string
encodeUTF8
encodeUTF8
(
str
:
string
)
:
Uint8Array
Parameters
str:
string
Returns
Uint8Array
generate
Headers
generate
Headers
(
masterKey
:
string
, method
:
HTTPMethod
, resourceType
?:
ResourceType
, resourceId
?:
string
, date
?:
Date
)
:
Promise
<
object
>
Parameters
masterKey:
string
method:
HTTPMethod
Default value
resourceType:
ResourceType
= ResourceType.none
Default value
resourceId:
string
= ""
Default value
date:
Date
= new Date()
Returns
Promise
<
object
>
hmac
hmac
(
key
:
string
, message
:
string
)
:
Promise
<
string
>
Parameters
key:
string
message:
string
Returns
Promise
<
string
>
Globals
Conflict
Resolution
Mode
Connection
Mode
Consistency
Level
Data
Type
Index
Kind
Indexing
Mode
Permission
Mode
Trigger
Operation
Trigger
Type
User
Defined
Function
Type
Change
Feed
Iterator
Change
Feed
Response
Client
Side
Metrics
Conflict
Conflict
Response
Conflicts
Container
Container
Response
Containers
Cosmos
Client
Database
Database
Account
Database
Response
Databases
Feed
Response
Item
Item
Response
Items
Offer
Offer
Response
Offers
Permission
Permission
Response
Permissions
Query
Iterator
Query
Metrics
Query
Preparation
Times
Resource
Response
Runtime
Execution
Times
Scripts
Stored
Procedure
Stored
Procedure
Response
Stored
Procedures
Timeout
Error
Trigger
Trigger
Response
Triggers
User
User
Defined
Function
User
Defined
Function
Response
User
Defined
Functions
User
Response
Users
Agent
Change
Feed
Options
Conflict
Definition
Conflict
Resolution
Policy
Connection
Policy
Container
Definition
Container
Request
Cosmos
Client
Options
Cosmos
Headers
Database
Definition
Database
Request
Document
Error
Response
Feed
Options
Index
Indexed
Path
Indexing
Policy
Item
Definition
JSONArray
JSONObject
Location
Min
Aggregate
Result
Offer
Definition
Partition
Key
Definition
Permission
Body
Permission
Definition
Request
Options
Resource
Retry
Context
Retry
Options
Shared
Options
Sql
Parameter
Sql
Query
Spec
Stored
Procedure
Definition
Trigger
Definition
Unique
Key
Unique
Key
Policy
User
Defined
Function
Definition
User
Definition
JSONValue
Partition
Key
Sub
Status
Code
Token
Provider
DEFAULT_
PARTITION_
KEY_
PATH
atob
digest
encode
Base64
encodeUTF8
generate
Headers
hmac
Generated using
TypeDoc