[docs] Migrate docs from AsciiDoc to Markdown (#2635)

* delete asciidoc files * add migrated files * Apply suggestions from review Co-authored-by: Josh Mock <josh@joshmock.com> * Apply suggestions from review Co-authored-by: Josh Mock <josh@joshmock.com> * add the new ci checks (#2634) --------- Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> Co-authored-by: Josh Mock <josh@joshmock.com>
2025-02-27 11:51:14 -06:00
parent ac231c859e
commit 3e5e568c07
142 changed files with 18203 additions and 31131 deletions
--- a/docs/reference/typescript.md
+++ b/docs/reference/typescript.md
@ -0,0 +1,91 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/typescript.html
+---
+
+# TypeScript support [typescript]
+
+The client offers a first-class support for TypeScript, shipping a complete set of type definitions of Elasticsearch’s API surface.
+
+The types are not 100% complete yet. Some APIs are missing (the newest ones, e.g. EQL), and others may contain some errors, but we are continuously pushing fixes & improvements. Contribute type fixes and improvements to [elasticsearch-specification github repository](https://github.com/elastic/elasticsearch-specification).
+
+::::{note}
+The client is developed against the [latest](https://www.npmjs.com/package/typescript?activeTab=versions) version of TypeScript. Furthermore, unless you have set `skipLibCheck` to `true`, you should configure `esModuleInterop` to `true`.
+::::
+
+
+
+## Example [_example]
+
+```ts
+import { Client } from '@elastic/elasticsearch'
+
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+
+interface Document {
+  character: string
+  quote: string
+}
+
+async function run () {
+  // Let's start by indexing some data
+  await client.index({
+    index: 'game-of-thrones',
+    document: {
+      character: 'Ned Stark',
+      quote: 'Winter is coming.'
+    }
+  })
+
+  await client.index({
+    index: 'game-of-thrones',
+    document: {
+      character: 'Daenerys Targaryen',
+      quote: 'I am the blood of the dragon.'
+    }
+  })
+
+  await client.index({
+    index: 'game-of-thrones',
+    document: {
+      character: 'Tyrion Lannister',
+      quote: 'A mind needs books like a sword needs a whetstone.'
+    }
+  })
+
+  // here we are forcing an index refresh, otherwise we will not
+  // get any result in the consequent search
+  await client.indices.refresh({ index: 'game-of-thrones' })
+
+  // Let's search!
+  const result= await client.search<Document>({
+    index: 'game-of-thrones',
+    query: {
+      match: { quote: 'winter' }
+    }
+  })
+
+  console.log(result.hits.hits)
+}
+
+run().catch(console.log)
+```
+
+
+## Request & Response types [_request_response_types]
+
+You can import the full TypeScript requests & responses definitions as it follows:
+
+```ts
+import { estypes } from '@elastic/elasticsearch'
+```
+
+If you need the legacy definitions with the body, you can do the following:
+
+```ts
+import { estypesWithBody } from '@elastic/elasticsearch'
+```
+