Skip to content

Remove dangling references to typesWithBodyKey #2821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 5, 2025
Merged

Remove dangling references to typesWithBodyKey #2821

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e25366
Remove dangling references to typesWithBodyKey
JoshMock May 5, 2025
8afd566
Merge branch 'main' into drop-types-with-body-refs
JoshMock May 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions docs/reference/typescript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ The types are not 100% complete yet. Some APIs are missing (the newest ones, e.g
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
Expand Down Expand Up @@ -74,18 +72,10 @@ async function run () {
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'
```

1 change: 0 additions & 1 deletion index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import SniffingTransport from './lib/sniffingTransport'

export * from '@elastic/transport'
export * as estypes from './lib/api/types'
export * as estypesWithBody from './lib/api/typesWithBodyKey'
export { Client, SniffingTransport }
export type { ClientOptions, NodeOptions } from './lib/client'
export * as helpers from './lib/helpers'