@azure/cosmos
Version:
Microsoft Azure Cosmos DB Service Node.js SDK for NOSQL API
45 lines • 2.2 kB
TypeScript
import type { SharedOptions } from "../index.js";
/**
* Options that can be specified for a requested issued to the Azure Cosmos DB servers.=
*/
export interface RequestOptions extends SharedOptions {
/** Conditions Associated with the request. */
accessCondition?: {
/** Conditional HTTP method header type (IfMatch or IfNoneMatch). */
type: string;
/** Conditional HTTP method header value (the _etag field from the last version you read). */
condition: string;
};
/** Enables or disables logging in JavaScript stored procedures. */
enableScriptLogging?: boolean;
/** Specifies indexing directives (index, do not index .. etc). */
indexingDirective?: string;
/** The offer throughput provisioned for a container in measurement of Requests-per-Unit. */
offerThroughput?: number;
/**
* Offer type when creating document containers.
*
* This option is only valid when creating a document container.
*/
offerType?: string;
/** Enables/disables getting document container quota related stats for document container read requests. */
populateQuotaInfo?: boolean;
/** Indicates what is the post trigger to be invoked after the operation. */
postTriggerInclude?: string | string[];
/** Indicates what is the pre trigger to be invoked before the operation. */
preTriggerInclude?: string | string[];
/** Expiry time (in seconds) for resource token associated with permission (applicable only for requests on permissions). */
resourceTokenExpirySeconds?: number;
/** (Advanced use case) The url to connect to. */
urlConnection?: string;
/** Disable automatic id generation (will cause creates to fail if id isn't on the definition) */
disableAutomaticIdGeneration?: boolean;
/**
* If set to false, service doesn't return payload in the response. It reduces networking and CPU load
* by not sending the payload back over the network. Default value is true.
*
* NOTE: Currently, this option is only supported for bulk and batch operations.
*/
contentResponseOnWriteEnabled?: boolean;
}
//# sourceMappingURL=RequestOptions.d.ts.map