« 传输 API 参考 »
Elastic 文档 ›Elasticsearch JavaScript 客户端 [8.14] ›集成

TypeScript 支持

编辑

TypeScript 支持编辑

该客户端为 TypeScript 提供一流的支持，提供 Elasticsearch API 表面的完整类型定义集。

这些类型尚未 100% 完成。 一些 API 缺失（最新的 API，例如 EQL），而其他 API 可能包含一些错误，但我们正在不断推送修复和改进。 为 elasticsearch-specification github 仓库 贡献类型修复和改进。

该客户端是针对 最新 版本的 TypeScript 开发的。 此外，除非您已将 skipLibCheck 设置为 true，否则您应该将 esModuleInterop 配置为 true。

示例编辑

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)

请求和响应类型编辑

您可以按如下方式导入完整的 TypeScript 请求和响应定义

import { estypes } from '@elastic/elasticsearch'

如果您需要带有正文的旧定义，则可以执行以下操作

import { estypesWithBody } from '@elastic/elasticsearch'
« 传输 API 参考 »