Skip to main content

@terascope/opensearch-client / client/method-helpers/delete

client/method-helpers/delete

Functions​

convertDeleteParams()​

convertDeleteParams(params, distributionMeta): { id: string; if_primary_term?: number; if_seq_no?: number; index: string; refresh?: boolean | "wait_for" | "true" | "false"; routing?: string; timeout?: string | number; version?: number; version_type?: VersionType; wait_for_active_shards?: number | "all"; } | { id: string; if_primary_term?: number; if_seq_no?: number; index: string; refresh?: boolean | "wait_for" | "true" | "false"; routing?: string; timeout?: string | number; type: string; version?: number; version_type?: VersionType; wait_for_active_shards?: number | "all"; }

Defined in: opensearch-client/src/client/method-helpers/delete.ts:3

Parameters​

ParameterType
paramsDeleteParams
distributionMetaClientMetadata

Returns​

{ id: string; if_primary_term?: number; if_seq_no?: number; index: string; refresh?: boolean | "wait_for" | "true" | "false"; routing?: string; timeout?: string | number; version?: number; version_type?: VersionType; wait_for_active_shards?: number | "all"; } | { id: string; if_primary_term?: number; if_seq_no?: number; index: string; refresh?: boolean | "wait_for" | "true" | "false"; routing?: string; timeout?: string | number; type: string; version?: number; version_type?: VersionType; wait_for_active_shards?: number | "all"; }