habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] Fix various syntax and rendering errors (#2776)

Browse Source
This commit is contained in:
Colleen McGinnis
2025-04-24 11:51:45 -05:00
committed by GitHub
parent be0b96b5f5
commit 926b468c6d
4 changed files with 170 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/reference/basic-config.md
View File

@ -82,8 +82,6 @@ auth: {
}
```
---
### `maxRetries`
Type: `number`<br>
@ -91,8 +89,6 @@ Default: `3`
Max number of retries for each request.
---
### `requestTimeout`
Type: `number`<br>
@ -100,8 +96,6 @@ Default: `No value`
Max request timeout in milliseconds for each request.
---
### `pingTimeout`
Type: `number`<br>
@ -109,8 +103,6 @@ Default: `3000`
Max ping request timeout in milliseconds for each request.
---
### `sniffInterval`
Type: `number, boolean`<br>
@ -122,8 +114,6 @@ Perform a sniff operation every `n` milliseconds.
Sniffing might not be the best solution. Before using the various `sniff` options, review this [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
:::
---
### `sniffOnStart`
Type: `boolean`<br>
@ -131,8 +121,6 @@ Default: `false`
Perform a sniff once the client is started. Be sure to review the sniffing best practices [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
---
### `sniffEndpoint`
Type: `string`<br>
@ -140,8 +128,6 @@ Default: `'_nodes/_all/http'`
Endpoint to ping during a sniff. Be sure to review the sniffing best practices [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
---
### `sniffOnConnectionFault`
Type: `boolean`<br>
@ -149,8 +135,6 @@ Default: `false`
Perform a sniff on connection fault. Be sure to review the sniffing best practices [blog post](https://www.elastic.co/blog/elasticsearch-sniffing-best-practices-what-when-why-how).
---
### `resurrectStrategy`
Type: `string`<br>
@ -159,8 +143,6 @@ Default: `'ping'`
Configure the node resurrection strategy.<br>
Options: `'ping'`, `'optimistic'`, `'none'`
---
### `suggestCompression`
Type: `boolean`<br>
@ -168,8 +150,6 @@ Default: `false`
Adds an `accept-encoding` header to every request.
---
### `compression`
Type: `string, boolean`<br>
@ -178,8 +158,6 @@ Default: `false`
Enables gzip request body compression.<br>
Options: `'gzip'`, `false`
---
### `tls`
Type: `http.SecureContextOptions`<br>
@ -187,8 +165,6 @@ Default: `null`
The [tls configuraton](https://nodejs.org/api/tls.html).
---
### `proxy`
Type: `string, URL`<br>
@ -208,8 +184,6 @@ const client = new Client({
})
```
---
### `agent`
Type: `http.AgentOptions, function`<br>
@ -237,8 +211,6 @@ const client = new Client({
})
```
---
### `nodeFilter`
Type: `function`
@ -260,8 +232,6 @@ function defaultNodeFilter (conn) {
}
```
---
### `nodeSelector`
Type: `function`<br>
@ -279,8 +249,6 @@ function nodeSelector (connections) {
}
```
---
### `generateRequestId`
Type: `function`<br>
@ -297,8 +265,6 @@ function generateRequestId (params, options) {
}
```
---
### `name`
Type: `string, symbol`<br>
@ -306,8 +272,6 @@ Default: `elasticsearch-js`
The name to identify the client instance in the events.
---
### `opaqueIdPrefix`
Type: `string`<br>
@ -316,8 +280,6 @@ Default: `null`
A string that will be use to prefix any `X-Opaque-Id` header.
See [`X-Opaque-Id` support](/reference/observability.md#_x_opaque_id_support) for more details.
---
### `headers`
Type: `object`<br>
@ -325,8 +287,6 @@ Default: `{}`
A set of custom headers to send in every request.
---
### `context`
Type: `object`<br>
@ -334,8 +294,6 @@ Default: `null`
A custom object that you can use for observability in your events. It will be merged with the API level context option.
---
### `enableMetaHeader`
Type: `boolean`<br>
@ -343,8 +301,6 @@ Default: `true`
If true, adds an header named `'x-elastic-client-meta'`, containing some minimal telemetry data, such as the client and platform version.
---
### `cloud`
Type: `object`<br>
@ -366,16 +322,12 @@ const client = new Client({
})
```
---
### `disablePrototypePoisoningProtection`
Default: `true`
`boolean`, `'proto'`, `'constructor'` - The client can protect you against prototype poisoning attacks. For more information, refer to [Square Brackets are the Enemy](https://web.archive.org/web/20200319091159/https://hueniverse.com/square-brackets-are-the-enemy-ff5b9fd8a3e8?gi=184a27ee2a08). If needed, you can enable prototype poisoning protection entirely (`false`) or one of the two checks (`'proto'` or `'constructor'`). For performance reasons, it is disabled by default. To learn more, refer to the [`secure-json-parse` documentation](https://github.com/fastify/secure-json-parse).
---
### `caFingerprint`
Type: `string`<br>
@ -383,8 +335,6 @@ Default: `null`
If configured, verify that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied fingerprint. Only accepts SHA256 digest fingerprints.
---
### `maxResponseSize`
Type: `number`<br>
@ -392,8 +342,6 @@ Default: `null`
When configured, `maxResponseSize` verifies that the uncompressed response size is lower than the configured number. If it’s higher, the request will be canceled. The `maxResponseSize` cannot be higher than the value of `buffer.constants.MAX_STRING_LENGTH`.
---
### `maxCompressedResponseSize`
Type: `number`<br>
@ -401,8 +349,6 @@ Default: `null`
When configured, `maxCompressedResponseSize` verifies that the compressed response size is lower than the configured number. If it’s higher, the request will be canceled. The `maxCompressedResponseSize` cannot be higher than the value of `buffer.constants.MAX_STRING_LENGTH`.
---
### `redaction`
Type: `object`<br>
@ -414,8 +360,6 @@ Options for how to redact potentially sensitive data from metadata attached to `
[Read about redaction](/reference/advanced-config.md#redaction) for more details
::::
---
### `serverMode`
Type: `string`<br>