123
This commit is contained in:
267
node_modules/@redis/search/dist/commands/index.d.ts
generated
vendored
Normal file
267
node_modules/@redis/search/dist/commands/index.d.ts
generated
vendored
Normal file
@ -0,0 +1,267 @@
|
||||
import * as _LIST from './_LIST';
|
||||
import * as ALTER from './ALTER';
|
||||
import * as AGGREGATE_WITHCURSOR from './AGGREGATE_WITHCURSOR';
|
||||
import * as AGGREGATE from './AGGREGATE';
|
||||
import * as ALIASADD from './ALIASADD';
|
||||
import * as ALIASDEL from './ALIASDEL';
|
||||
import * as ALIASUPDATE from './ALIASUPDATE';
|
||||
import * as CONFIG_GET from './CONFIG_GET';
|
||||
import * as CONFIG_SET from './CONFIG_SET';
|
||||
import * as CREATE from './CREATE';
|
||||
import * as CURSOR_DEL from './CURSOR_DEL';
|
||||
import * as CURSOR_READ from './CURSOR_READ';
|
||||
import * as DICTADD from './DICTADD';
|
||||
import * as DICTDEL from './DICTDEL';
|
||||
import * as DICTDUMP from './DICTDUMP';
|
||||
import * as DROPINDEX from './DROPINDEX';
|
||||
import * as EXPLAIN from './EXPLAIN';
|
||||
import * as EXPLAINCLI from './EXPLAINCLI';
|
||||
import * as INFO from './INFO';
|
||||
import * as PROFILESEARCH from './PROFILE_SEARCH';
|
||||
import * as PROFILEAGGREGATE from './PROFILE_AGGREGATE';
|
||||
import * as SEARCH from './SEARCH';
|
||||
import * as SEARCH_NOCONTENT from './SEARCH_NOCONTENT';
|
||||
import * as SPELLCHECK from './SPELLCHECK';
|
||||
import * as SUGADD from './SUGADD';
|
||||
import * as SUGDEL from './SUGDEL';
|
||||
import * as SUGGET_WITHPAYLOADS from './SUGGET_WITHPAYLOADS';
|
||||
import * as SUGGET_WITHSCORES_WITHPAYLOADS from './SUGGET_WITHSCORES_WITHPAYLOADS';
|
||||
import * as SUGGET_WITHSCORES from './SUGGET_WITHSCORES';
|
||||
import * as SUGGET from './SUGGET';
|
||||
import * as SUGLEN from './SUGLEN';
|
||||
import * as SYNDUMP from './SYNDUMP';
|
||||
import * as SYNUPDATE from './SYNUPDATE';
|
||||
import * as TAGVALS from './TAGVALS';
|
||||
import { RedisCommandArgument, RedisCommandArguments } from '@redis/client/dist/lib/commands';
|
||||
import { SearchOptions } from './SEARCH';
|
||||
declare const _default: {
|
||||
_LIST: typeof _LIST;
|
||||
_list: typeof _LIST;
|
||||
ALTER: typeof ALTER;
|
||||
alter: typeof ALTER;
|
||||
AGGREGATE_WITHCURSOR: typeof AGGREGATE_WITHCURSOR;
|
||||
aggregateWithCursor: typeof AGGREGATE_WITHCURSOR;
|
||||
AGGREGATE: typeof AGGREGATE;
|
||||
aggregate: typeof AGGREGATE;
|
||||
ALIASADD: typeof ALIASADD;
|
||||
aliasAdd: typeof ALIASADD;
|
||||
ALIASDEL: typeof ALIASDEL;
|
||||
aliasDel: typeof ALIASDEL;
|
||||
ALIASUPDATE: typeof ALIASUPDATE;
|
||||
aliasUpdate: typeof ALIASUPDATE;
|
||||
CONFIG_GET: typeof CONFIG_GET;
|
||||
configGet: typeof CONFIG_GET;
|
||||
CONFIG_SET: typeof CONFIG_SET;
|
||||
configSet: typeof CONFIG_SET;
|
||||
CREATE: typeof CREATE;
|
||||
create: typeof CREATE;
|
||||
CURSOR_DEL: typeof CURSOR_DEL;
|
||||
cursorDel: typeof CURSOR_DEL;
|
||||
CURSOR_READ: typeof CURSOR_READ;
|
||||
cursorRead: typeof CURSOR_READ;
|
||||
DICTADD: typeof DICTADD;
|
||||
dictAdd: typeof DICTADD;
|
||||
DICTDEL: typeof DICTDEL;
|
||||
dictDel: typeof DICTDEL;
|
||||
DICTDUMP: typeof DICTDUMP;
|
||||
dictDump: typeof DICTDUMP;
|
||||
DROPINDEX: typeof DROPINDEX;
|
||||
dropIndex: typeof DROPINDEX;
|
||||
EXPLAIN: typeof EXPLAIN;
|
||||
explain: typeof EXPLAIN;
|
||||
EXPLAINCLI: typeof EXPLAINCLI;
|
||||
explainCli: typeof EXPLAINCLI;
|
||||
INFO: typeof INFO;
|
||||
info: typeof INFO;
|
||||
PROFILESEARCH: typeof PROFILESEARCH;
|
||||
profileSearch: typeof PROFILESEARCH;
|
||||
PROFILEAGGREGATE: typeof PROFILEAGGREGATE;
|
||||
profileAggregate: typeof PROFILEAGGREGATE;
|
||||
SEARCH: typeof SEARCH;
|
||||
search: typeof SEARCH;
|
||||
SEARCH_NOCONTENT: typeof SEARCH_NOCONTENT;
|
||||
searchNoContent: typeof SEARCH_NOCONTENT;
|
||||
SPELLCHECK: typeof SPELLCHECK;
|
||||
spellCheck: typeof SPELLCHECK;
|
||||
SUGADD: typeof SUGADD;
|
||||
sugAdd: typeof SUGADD;
|
||||
SUGDEL: typeof SUGDEL;
|
||||
sugDel: typeof SUGDEL;
|
||||
SUGGET_WITHPAYLOADS: typeof SUGGET_WITHPAYLOADS;
|
||||
sugGetWithPayloads: typeof SUGGET_WITHPAYLOADS;
|
||||
SUGGET_WITHSCORES_WITHPAYLOADS: typeof SUGGET_WITHSCORES_WITHPAYLOADS;
|
||||
sugGetWithScoresWithPayloads: typeof SUGGET_WITHSCORES_WITHPAYLOADS;
|
||||
SUGGET_WITHSCORES: typeof SUGGET_WITHSCORES;
|
||||
sugGetWithScores: typeof SUGGET_WITHSCORES;
|
||||
SUGGET: typeof SUGGET;
|
||||
sugGet: typeof SUGGET;
|
||||
SUGLEN: typeof SUGLEN;
|
||||
sugLen: typeof SUGLEN;
|
||||
SYNDUMP: typeof SYNDUMP;
|
||||
synDump: typeof SYNDUMP;
|
||||
SYNUPDATE: typeof SYNUPDATE;
|
||||
synUpdate: typeof SYNUPDATE;
|
||||
TAGVALS: typeof TAGVALS;
|
||||
tagVals: typeof TAGVALS;
|
||||
};
|
||||
export default _default;
|
||||
export declare enum RedisSearchLanguages {
|
||||
ARABIC = "Arabic",
|
||||
BASQUE = "Basque",
|
||||
CATALANA = "Catalan",
|
||||
DANISH = "Danish",
|
||||
DUTCH = "Dutch",
|
||||
ENGLISH = "English",
|
||||
FINNISH = "Finnish",
|
||||
FRENCH = "French",
|
||||
GERMAN = "German",
|
||||
GREEK = "Greek",
|
||||
HUNGARIAN = "Hungarian",
|
||||
INDONESAIN = "Indonesian",
|
||||
IRISH = "Irish",
|
||||
ITALIAN = "Italian",
|
||||
LITHUANIAN = "Lithuanian",
|
||||
NEPALI = "Nepali",
|
||||
NORWEIGAN = "Norwegian",
|
||||
PORTUGUESE = "Portuguese",
|
||||
ROMANIAN = "Romanian",
|
||||
RUSSIAN = "Russian",
|
||||
SPANISH = "Spanish",
|
||||
SWEDISH = "Swedish",
|
||||
TAMIL = "Tamil",
|
||||
TURKISH = "Turkish",
|
||||
CHINESE = "Chinese"
|
||||
}
|
||||
export type PropertyName = `${'@' | '$.'}${string}`;
|
||||
export type SortByProperty = string | {
|
||||
BY: string;
|
||||
DIRECTION?: 'ASC' | 'DESC';
|
||||
};
|
||||
export declare function pushSortByProperty(args: RedisCommandArguments, sortBy: SortByProperty): void;
|
||||
export declare function pushSortByArguments(args: RedisCommandArguments, name: string, sortBy: SortByProperty | Array<SortByProperty>): RedisCommandArguments;
|
||||
export declare function pushArgumentsWithLength(args: RedisCommandArguments, fn: (args: RedisCommandArguments) => void): RedisCommandArguments;
|
||||
export declare enum SchemaFieldTypes {
|
||||
TEXT = "TEXT",
|
||||
NUMERIC = "NUMERIC",
|
||||
GEO = "GEO",
|
||||
TAG = "TAG",
|
||||
VECTOR = "VECTOR",
|
||||
GEOSHAPE = "GEOSHAPE"
|
||||
}
|
||||
type CreateSchemaField<T extends SchemaFieldTypes, E = Record<PropertyKey, unknown>> = T | ({
|
||||
type: T;
|
||||
AS?: string;
|
||||
INDEXMISSING?: boolean;
|
||||
} & E);
|
||||
type CommonFieldArguments = {
|
||||
SORTABLE?: boolean | 'UNF';
|
||||
NOINDEX?: boolean;
|
||||
};
|
||||
type CreateSchemaCommonField<T extends SchemaFieldTypes, E = Record<PropertyKey, unknown>> = CreateSchemaField<T, (CommonFieldArguments & E)>;
|
||||
export declare enum SchemaTextFieldPhonetics {
|
||||
DM_EN = "dm:en",
|
||||
DM_FR = "dm:fr",
|
||||
FM_PT = "dm:pt",
|
||||
DM_ES = "dm:es"
|
||||
}
|
||||
type CreateSchemaTextField = CreateSchemaCommonField<SchemaFieldTypes.TEXT, {
|
||||
NOSTEM?: true;
|
||||
WEIGHT?: number;
|
||||
PHONETIC?: SchemaTextFieldPhonetics;
|
||||
WITHSUFFIXTRIE?: boolean;
|
||||
INDEXEMPTY?: boolean;
|
||||
}>;
|
||||
type CreateSchemaNumericField = CreateSchemaCommonField<SchemaFieldTypes.NUMERIC>;
|
||||
type CreateSchemaGeoField = CreateSchemaCommonField<SchemaFieldTypes.GEO>;
|
||||
type CreateSchemaTagField = CreateSchemaCommonField<SchemaFieldTypes.TAG, {
|
||||
SEPARATOR?: string;
|
||||
CASESENSITIVE?: true;
|
||||
WITHSUFFIXTRIE?: boolean;
|
||||
INDEXEMPTY?: boolean;
|
||||
}>;
|
||||
export declare enum VectorAlgorithms {
|
||||
FLAT = "FLAT",
|
||||
HNSW = "HNSW"
|
||||
}
|
||||
type CreateSchemaVectorField<T extends VectorAlgorithms, A extends Record<string, unknown>> = CreateSchemaField<SchemaFieldTypes.VECTOR, {
|
||||
ALGORITHM: T;
|
||||
TYPE: string;
|
||||
DIM: number;
|
||||
DISTANCE_METRIC: 'L2' | 'IP' | 'COSINE';
|
||||
INITIAL_CAP?: number;
|
||||
} & A>;
|
||||
type CreateSchemaFlatVectorField = CreateSchemaVectorField<VectorAlgorithms.FLAT, {
|
||||
BLOCK_SIZE?: number;
|
||||
}>;
|
||||
type CreateSchemaHNSWVectorField = CreateSchemaVectorField<VectorAlgorithms.HNSW, {
|
||||
M?: number;
|
||||
EF_CONSTRUCTION?: number;
|
||||
EF_RUNTIME?: number;
|
||||
}>;
|
||||
export declare const SCHEMA_GEO_SHAPE_COORD_SYSTEM: {
|
||||
readonly SPHERICAL: "SPHERICAL";
|
||||
readonly FLAT: "FLAT";
|
||||
};
|
||||
export type SchemaGeoShapeFieldCoordSystem = typeof SCHEMA_GEO_SHAPE_COORD_SYSTEM[keyof typeof SCHEMA_GEO_SHAPE_COORD_SYSTEM];
|
||||
type CreateSchemaGeoShapeField = CreateSchemaCommonField<SchemaFieldTypes.GEOSHAPE, {
|
||||
COORD_SYSTEM?: SchemaGeoShapeFieldCoordSystem;
|
||||
}>;
|
||||
export interface RediSearchSchema {
|
||||
[field: string]: CreateSchemaTextField | CreateSchemaNumericField | CreateSchemaGeoField | CreateSchemaTagField | CreateSchemaFlatVectorField | CreateSchemaHNSWVectorField | CreateSchemaGeoShapeField;
|
||||
}
|
||||
export declare function pushSchema(args: RedisCommandArguments, schema: RediSearchSchema): void;
|
||||
export type Params = Record<string, RedisCommandArgument | number>;
|
||||
export declare function pushParamsArgs(args: RedisCommandArguments, params?: Params): RedisCommandArguments;
|
||||
export declare function pushSearchOptions(args: RedisCommandArguments, options?: SearchOptions): RedisCommandArguments;
|
||||
interface SearchDocumentValue {
|
||||
[key: string]: string | number | null | Array<SearchDocumentValue> | SearchDocumentValue;
|
||||
}
|
||||
export interface SearchReply {
|
||||
total: number;
|
||||
documents: Array<{
|
||||
id: string;
|
||||
value: SearchDocumentValue;
|
||||
}>;
|
||||
}
|
||||
export interface ProfileOptions {
|
||||
LIMITED?: true;
|
||||
}
|
||||
export type ProfileRawReply<T> = [
|
||||
results: T,
|
||||
profile: [
|
||||
_: string,
|
||||
TotalProfileTime: string,
|
||||
_: string,
|
||||
ParsingTime: string,
|
||||
_: string,
|
||||
PipelineCreationTime: string,
|
||||
_: string,
|
||||
IteratorsProfile: Array<any>
|
||||
]
|
||||
];
|
||||
export interface ProfileReply {
|
||||
results: SearchReply | AGGREGATE.AggregateReply;
|
||||
profile: ProfileData;
|
||||
}
|
||||
interface ChildIterator {
|
||||
type?: string;
|
||||
counter?: number;
|
||||
term?: string;
|
||||
size?: number;
|
||||
time?: string;
|
||||
childIterators?: Array<ChildIterator>;
|
||||
}
|
||||
interface IteratorsProfile {
|
||||
type?: string;
|
||||
counter?: number;
|
||||
queryType?: string;
|
||||
time?: string;
|
||||
childIterators?: Array<ChildIterator>;
|
||||
}
|
||||
interface ProfileData {
|
||||
totalProfileTime: string;
|
||||
parsingTime: string;
|
||||
pipelineCreationTime: string;
|
||||
iteratorsProfile: IteratorsProfile;
|
||||
}
|
||||
export declare function transformProfile(reply: Array<any>): ProfileData;
|
||||
Reference in New Issue
Block a user