/* * Licensed to Elasticsearch B.V. under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch B.V. licenses this file to you 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. */ import { expectType, expectError } from 'tsd' import { Readable as ReadableStream } from 'stream'; import { TransportRequestCallback, Context } from '../../lib/Transport' import { Client, ApiError } from '../../' const client = new Client({ node: 'http://localhost:9200' }) interface SearchBody { query: { match: { foo: string } } } interface ShardsResponse { total: number; successful: number; failed: number; skipped: number; } interface Explanation { value: number; description: string; details: Explanation[]; } interface SearchResponse { took: number; timed_out: boolean; _scroll_id?: string; _shards: ShardsResponse; hits: { total: number; max_score: number; hits: Array<{ _index: string; _type: string; _id: string; _score: number; _source: T; _version?: number; _explanation?: Explanation; fields?: any; highlight?: any; inner_hits?: any; matched_queries?: string[]; sort?: string[]; }>; }; aggregations?: any; } interface Source { foo: string } // body that does not respect the RequestBody constraint expectError( client.search({ index: 'hello', body: 42 }).then(console.log) ) // No generics (promise style) { const response = await client.search({ index: 'test', body: { query: { match: { foo: 'bar' } } } }) expectType>(response.body) expectType(response.meta.context) } // Define only the response body (promise style) { const response = await client.search>({ index: 'test', body: { query: { match: { foo: 'bar' } } } }) expectType>(response.body) expectType(response.meta.context) } // Define response body and request body (promise style) { const response = await client.search, SearchBody>({ index: 'test', body: { query: { match: { foo: 'bar' } } } }) expectType>(response.body) expectType(response.meta.context) } // Define response body, request body and the context (promise style) { const response = await client.search, SearchBody, Context>({ index: 'test', body: { query: { match: { foo: 'bar' } } } }) expectType>(response.body) expectType(response.meta.context) } // Send request body as string (promise style) { const response = await client.search({ index: 'test', body: 'hello world' }) expectType>(response.body) expectType(response.meta.context) } // Send request body as buffer (promise style) { const response = await client.search({ index: 'test', body: Buffer.from('hello world') }) expectType>(response.body) expectType(response.meta.context) } // Send request body as readable stream (promise style) { const response = await client.search({ index: 'test', body: new ReadableStream() }) expectType>(response.body) expectType(response.meta.context) } // No generics (callback style) { const result = client.search({ index: 'test', body: { query: { match: { foo: 'bar' } } } }, (err, response) => { expectType(err) expectType>(response.body) expectType(response.meta.context) }) expectType(result) } // Define only the response body (callback style) { const result = client.search>({ index: 'test', body: { query: { match: { foo: 'bar' } } } }, (err, response) => { expectType(err) expectType>(response.body) expectType(response.meta.context) }) expectType(result) } // Define response body and request body (callback style) { const result = client.search, SearchBody>({ index: 'test', body: { query: { match: { foo: 'bar' } } } }, (err, response) => { expectType(err) expectType>(response.body) expectType(response.meta.context) }) expectType(result) } // Define response body, request body and the context (callback style) { const result = client.search, SearchBody, Context>({ index: 'test', body: { query: { match: { foo: 'bar' } } } }, (err, response) => { expectType(err) expectType>(response.body) expectType(response.meta.context) }) expectType(result) } // Send request body as string (callback style) { const result = client.search({ index: 'test', body: 'hello world' }, (err, response) => { expectType(err) expectType>(response.body) expectType(response.meta.context) }) expectType(result) } // Send request body as buffer (callback style) { const result = client.search({ index: 'test', body: Buffer.from('hello world') }, (err, response) => { expectType(err) expectType>(response.body) expectType(response.meta.context) }) expectType(result) } // Send request body as readable stream (callback style) { const result = client.search({ index: 'test', body: new ReadableStream() }, (err, response) => { expectType(err) expectType>(response.body) expectType(response.meta.context) }) expectType(result) }