mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-10-04 06:47:03 +00:00
Merge pull request #9783 from CasperSkydt/feature_add_elasticsearch
Added elasticsearch
This commit is contained in:
Mohamed Hegazy
@@ -0,0 +1,35 @@
|
||||
/// <reference path="elasticsearch.d.ts"/>
|
||||
import elasticsearch = require("elasticsearch");
|
||||
|
||||
var client = new elasticsearch.Client({
|
||||
host: 'localhost:9200',
|
||||
log: 'trace'
|
||||
});
|
||||
|
||||
client = new elasticsearch.Client({
|
||||
hosts: [
|
||||
'box1.server.org',
|
||||
'box2.server.org'
|
||||
],
|
||||
selector: function (hosts: any) { }
|
||||
});
|
||||
|
||||
client.ping({
|
||||
requestTimeout: 30000,
|
||||
hello: "elasticsearch"
|
||||
}, function (error) {
|
||||
});
|
||||
|
||||
client.search({
|
||||
q: 'pants'
|
||||
}).then(function (body) {
|
||||
var hits = body.hits.hits;
|
||||
}, function (error) {
|
||||
});
|
||||
|
||||
client.indices.delete({
|
||||
index: 'test_index',
|
||||
ignore: [404]
|
||||
}).then(function (body) {
|
||||
}, function (error) {
|
||||
});
|
||||
Vendored
+274
@@ -0,0 +1,274 @@
|
||||
// Type definitions for elasticsearch
|
||||
// Project: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html
|
||||
// Definitions by: Casper Skydt <https://github.com/CasperSkydt/DefinitelyTyped>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
declare module Elasticsearch {
|
||||
export class Client {
|
||||
constructor(params: ConfigOptions);
|
||||
indices: Indices;
|
||||
bulk(params: BulkIndexDocumentsParams): PromiseLike<any>;
|
||||
bulk(params: BulkIndexDocumentsParams, callback: (error: any, response: any) => void): void;
|
||||
delete(params: DeleteDocumentParams): PromiseLike<any>;
|
||||
delete(params: DeleteDocumentParams, callback: (error: any, response: any) => void): void;
|
||||
get(params: GetParams, callback: (error: any, response: any) => void): void;
|
||||
get<T>(params: GetParams): PromiseLike<GetResponse<T>>;
|
||||
index<T>(params: IndexDocumentParams<T>): PromiseLike<any>;
|
||||
index<T>(params: IndexDocumentParams<T>, callback: (error: any, response: any) => void): void;
|
||||
mget(params: MGetParams, callback: (error: any, response: any) => void): void;
|
||||
mget<T>(params: MGetParams): PromiseLike<GetResponse<T>>;
|
||||
msearch(params: MSearchParams, callback: (error: any, response: any) => void): void;
|
||||
msearch<T>(params: MSearchParams): PromiseLike<GetResponse<T>>;
|
||||
ping(params: PingParams): PromiseLike<any>;
|
||||
ping(params: PingParams, callback: (err: any, response: any, status: any) => void): void;
|
||||
scroll(params: ScrollParams): PromiseLike<any>;
|
||||
scroll(params: ScrollParams, callback: (error: any, response: any) => void): void;
|
||||
search(params: SearchParams): PromiseLike<any>;
|
||||
search(params: SearchParams, callback: (error: any, response: any) => void): void;
|
||||
suggest(params: SuggestParams): PromiseLike<any>;
|
||||
suggest(params: SuggestParams, callback: (error: any, response: any) => void): void;
|
||||
update(params: UpdateDocumentParams): PromiseLike<any>;
|
||||
update(params: UpdateDocumentParams, callback: (error: any, response: any) => void): void;
|
||||
}
|
||||
|
||||
export class Indices {
|
||||
delete(params: IndicesDeleteParams, callback: (error: any, response: any, status: any) => void): void;
|
||||
delete(params: IndicesDeleteParams): PromiseLike<any>;
|
||||
create(params: IndicesCreateParams, callback: (error: any, response: any, status: any) => void): void;
|
||||
create(params: IndicesCreateParams): PromiseLike<any>;
|
||||
exists(params: IndicesIndexExitsParams, callback: (error: any, response: any, status: any) => void): void;
|
||||
exists(params: IndicesIndexExitsParams): PromiseLike<any>;
|
||||
get(params: IndicesGetParams, callback: (error: any, response: any, status: any) => void): void;
|
||||
get(params: IndicesGetParams): PromiseLike<any>;
|
||||
getAlias(params: IndicesGetAliasParams, callback: (error: any, response: any, status: any) => void): void;
|
||||
getAlias(params: IndicesGetAliasParams): PromiseLike<any>;
|
||||
putAlias(params: IndicesPutAliasParams, callback: (error: any, response: any, status: any) => void): void;
|
||||
putAlias(params: IndicesPutAliasParams): PromiseLike<any>;
|
||||
putTemplate(params: IndicesPutTemplateParams, callback: (error: any, response: any) => void): void;
|
||||
putTemplate(params: IndicesPutTemplateParams): PromiseLike<any>;
|
||||
refresh(params: IndicesRefreshParams, callback: (error: any, response: any) => void): void;
|
||||
refresh(params: IndicesRefreshParams): PromiseLike<any>;
|
||||
}
|
||||
|
||||
export interface ConfigOptions{
|
||||
host?: any;
|
||||
hosts?: any;
|
||||
log?: any;
|
||||
apiVersion?: string;
|
||||
plugins?: any;
|
||||
sniffOnStart?: boolean;
|
||||
sniffInterval?: number;
|
||||
sniffOnConnectionFault?: boolean;
|
||||
maxRetries?: number;
|
||||
requestTimeout?: number;
|
||||
deadTimeout?: number;
|
||||
pingTimeout?: number;
|
||||
keepAlive?: boolean;
|
||||
maxSockets?: number;
|
||||
suggestCompression?: boolean;
|
||||
connectionClass?: string;
|
||||
sniffedNodesProtocol?: string;
|
||||
ssl?: Object;
|
||||
selector?: any;
|
||||
defer?: () => void;
|
||||
nodesToHostCallback?: any;
|
||||
createNodeAgent?: any;
|
||||
}
|
||||
|
||||
export interface GenericParams {
|
||||
requestTimeout?: number;
|
||||
maxRetries?: number;
|
||||
method?: string;
|
||||
body?: any;
|
||||
ignore?: number | number[];
|
||||
}
|
||||
|
||||
export interface BulkIndexDocumentsParams extends GenericParams {
|
||||
refresh?: boolean;
|
||||
routing? : string;
|
||||
timeout?: number | Date;
|
||||
type?: string;
|
||||
fields?: string | string[] | boolean;
|
||||
index?: string;
|
||||
}
|
||||
|
||||
export interface IndicesGetParams extends GenericParams {
|
||||
ignoreUnavailable?: boolean;
|
||||
index: string | string[] | boolean;
|
||||
}
|
||||
|
||||
export interface IndicesRefreshParams extends GenericParams {
|
||||
force?: boolean;
|
||||
ignoreUnavailable?: boolean;
|
||||
index: string | string[] | boolean;
|
||||
}
|
||||
|
||||
export interface IndicesDeleteParams extends GenericParams {
|
||||
index: string | string[] | boolean;
|
||||
timeout?: Date | number;
|
||||
masterTimeout?: Date | number;
|
||||
}
|
||||
|
||||
export interface IndicesCreateParams extends GenericParams {
|
||||
index: string | string[] | boolean;
|
||||
timeout?: Date | number;
|
||||
masterTimeout?: Date | number;
|
||||
}
|
||||
|
||||
export interface IndicesPutTemplateParams extends GenericParams {
|
||||
order?: number;
|
||||
create?: boolean;
|
||||
timeout?: Date | number;
|
||||
masterTimeout?: Date | number;
|
||||
flatSettings?: boolean;
|
||||
name: string;
|
||||
body: string | any;
|
||||
}
|
||||
|
||||
export interface IndicesGetAliasParams extends GenericParams {
|
||||
ignoreUnavailable?: boolean;
|
||||
allowNoIndices?: boolean;
|
||||
expandWildcards?: string;
|
||||
local?: boolean;
|
||||
index?: string | string[] | boolean;
|
||||
name: string | string[] | boolean;
|
||||
}
|
||||
|
||||
export interface IndicesPutAliasParams extends GenericParams {
|
||||
index?: string | string[] | boolean;
|
||||
name: string | string[] | boolean;
|
||||
}
|
||||
|
||||
export interface GetParams extends GenericParams {
|
||||
index: string;
|
||||
type: string;
|
||||
id: string;
|
||||
fields?: string | string[] | boolean;
|
||||
parent?: string;
|
||||
preference?: string;
|
||||
realtime?: boolean;
|
||||
refresh?: boolean;
|
||||
routing?: string;
|
||||
_source?: string | string[] | boolean;
|
||||
_sourceExclude?: string | string[] | boolean;
|
||||
_sourceInclude?: string | string[] | boolean;
|
||||
version?: number;
|
||||
versionType?: string;
|
||||
}
|
||||
|
||||
export interface GetResponse<T> extends GenericParams {
|
||||
_type: string;
|
||||
_id: string;
|
||||
_version: number;
|
||||
found: boolean;
|
||||
_source: T;
|
||||
}
|
||||
|
||||
export interface IndexDocumentParams<T> extends GenericParams {
|
||||
index: string;
|
||||
type: string;
|
||||
id: string;
|
||||
body: T;
|
||||
consistensy?: string;
|
||||
parent?: string;
|
||||
replication?: string;
|
||||
routing?: string;
|
||||
timeout?: Date | number;
|
||||
timestamp?: Date | number;
|
||||
version?: number;
|
||||
versionType?: string;
|
||||
}
|
||||
|
||||
export interface ScrollParams extends GenericParams {
|
||||
scroll: string;
|
||||
scrollId: string;
|
||||
}
|
||||
|
||||
export interface SearchParams extends GenericParams {
|
||||
index?: string;
|
||||
type?: string | string[] | number;
|
||||
body?: any;
|
||||
q?: string;
|
||||
scroll?: string;
|
||||
search_type?: string;
|
||||
fields?: string[];
|
||||
size?: number;
|
||||
sort?: string | string[] | boolean;
|
||||
_source?: string | string[] | boolean;
|
||||
_sourceExclude?: string | string[] | boolean;
|
||||
_sourceInclude?: string | string[] | boolean;
|
||||
stats?: string | string[] | boolean;
|
||||
suggestField?: string;
|
||||
suggestSize?: number;
|
||||
suggestText?: string;
|
||||
timeout?: Date | number;
|
||||
}
|
||||
|
||||
export interface MSearchParams extends GenericParams {
|
||||
index?: string | string[] | Boolean;
|
||||
type?: string | string[] | Boolean;
|
||||
search_type?: string;
|
||||
}
|
||||
|
||||
export interface MGetParams extends GenericParams {
|
||||
fields?: string | string[] | Boolean;
|
||||
preference?: string;
|
||||
realtime?: Boolean;
|
||||
refresh?: Boolean;
|
||||
_sourceExclude?: string | string[] | boolean;
|
||||
_sourceInclude?: string | string[] | boolean;
|
||||
index?: string;
|
||||
type?: string;
|
||||
}
|
||||
|
||||
export interface IndicesIndexExitsParams extends GenericParams {
|
||||
index: string | string[] | boolean;
|
||||
ignoreUnavailable?: boolean;
|
||||
}
|
||||
|
||||
export interface PingParams extends GenericParams {
|
||||
requestTimeout?: number;
|
||||
hello?: string;
|
||||
}
|
||||
|
||||
export interface DeleteDocumentParams extends GenericParams {
|
||||
index: string;
|
||||
type: string;
|
||||
id: string;
|
||||
refresh?: boolean;
|
||||
}
|
||||
|
||||
export interface UpdateDocumentParams extends GenericParams {
|
||||
index: string;
|
||||
type: string;
|
||||
id: string;
|
||||
body?: string | any;
|
||||
version?: Number;
|
||||
timesstamp?: Date | Number;
|
||||
scriptedUpsert?: Boolean;
|
||||
scriptId?: any;
|
||||
script?: any;
|
||||
routing?: string;
|
||||
retryOnConflict?: Number;
|
||||
refresh?: Boolean;
|
||||
parent?: string;
|
||||
lang?:string;
|
||||
fields?: string | string[] | Boolean;
|
||||
consistensy?: string;
|
||||
}
|
||||
|
||||
export interface SuggestParams extends GenericParams {
|
||||
ignoreUnavailable?: boolean;
|
||||
allowNoIndices?: boolean;
|
||||
expandWildcards?: string;
|
||||
preference?: string;
|
||||
routing?: string;
|
||||
source?: string;
|
||||
body: string | any;
|
||||
index: string | string[] | boolean;
|
||||
}
|
||||
}
|
||||
|
||||
declare module "elasticsearch" {
|
||||
export = Elasticsearch;
|
||||
}
|
||||
Reference in New Issue
Block a user