-
Notifications
You must be signed in to change notification settings - Fork 4
/
types.ts
29 lines (28 loc) · 1.21 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
// Copyright DataStax, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/**
* Represents options related to timeouts. Note that this means "the max time the client will wait for a response
* from the server"—**an operation timing out does not necessarily mean the operation failed on the server**.
*
* On paginated operations, the timeout applies across all network requests. For example, if you set a timeout of 5
* seconds and the operation requires 3 network requests, each request must complete in less than 5 seconds total.
*
* @public
*/
export interface WithTimeout {
/**
* The maximum time to wait for a response from the server, in milliseconds.
*/
maxTimeMS?: number;
}