@redis/search 1.0.6

package/README.md

@@ -0,0 +1,120 @@
+# @redis/search
+
+This package provides support for the [RediSearch](https://redisearch.io) module, which adds indexing and querying support for data stored in Redis Hashes or as JSON documents with the RedisJSON module.  It extends the [Node Redis client](https://github.com/redis/node-redis) to include functions for each of the RediSearch commands.
+
+To use these extra commands, your Redis server must have the RediSearch module installed.  To index and query JSON documents, you'll also need to add the RedisJSON module.
+
+## Usage
+
+For complete examples, see [`search-hashes.js`](https://github.com/redis/node-redis/blob/master/examples/search-hashes.js) and [`search-json.js`](https://github.com/redis/node-redis/blob/master/examples/search-json.js) in the Node Redis examples folder.
+
+### Indexing and Querying Data in Redis Hashes
+
+#### Creating an Index
+
+Before we can perform any searches, we need to tell RediSearch how to index our data, and which Redis keys to find that data in.  The [FT.CREATE](https://oss.redis.com/redisearch/Commands/#ftcreate) command creates a RediSearch index.  Here's how to use it to create an index we'll call `idx:animals` where we want to index hashes containing `name`, `species` and `age` fields, and whose key names in Redis begin with the prefix `noderedis:animals`:
+
+```javascript
+await client.ft.create('idx:animals', {
+  name: {
+    type: SchemaFieldTypes.TEXT,
+    sortable: true
+  },
+    species: SchemaFieldTypes.TAG,
+    age: SchemaFieldTypes.NUMERIC
+  }, {
+    ON: 'HASH',
+    PREFIX: 'noderedis:animals'
+  }
+);
+```
+
+See the [`FT.CREATE` documentation](https://oss.redis.com/redisearch/Commands/#ftcreate) for information about the different field types and additional options.
+
+#### Querying the Index
+
+Once we've created an index, and added some data to Redis hashes whose keys begin with the prefix `noderedis:animals`, we can start writing some search queries.  RediSearch supports a rich query syntax for full-text search, faceted search, aggregation and more.  Check out the [`FT.SEARCH` documentation](https://oss.redis.com/redisearch/Commands/#ftsearch) and the [query syntax reference](https://oss.redis.com/redisearch/Query_Syntax/) for more information.
+
+Let's write a query to find all the animals where the `species` field has the value `dog`:
+
+```javascript
+const results = await client.ft.search('idx:animals', '@species:{dog}');
+```
+
+`results` looks like this:
+
+```javascript
+{
+  total: 2,
+  documents: [
+    {
+      id: 'noderedis:animals:4',
+      value: {
+        name: 'Fido',
+        species: 'dog',
+        age: '7'
+      }
+    },
+    {
+      id: 'noderedis:animals:3',
+      value: {
+        name: 'Rover',
+        species: 'dog',
+        age: '9'
+      }
+    }
+  ]
+}
+```
+
+### Indexing and Querying Data with RedisJSON
+
+RediSearch can also index and query JSON documents stored in Redis using the RedisJSON module.  The approach is similar to that for indexing and searching data in hashes, but we can now use JSON Path like syntax and the data no longer has to be flat name/value pairs - it can contain nested objects and arrays.
+
+#### Creating an Index
+
+As before, we create an index with the `FT.CREATE` command, this time specifying we want to index JSON documents that look like this:
+
+```javascript
+{
+  name: 'Alice',
+  age: 32,
+  coins: 100
+}
+```
+
+Each document represents a user in some system, and users have name, age and coins properties.
+
+One way we might choose to index these documents is as follows:
+
+```javascript
+await client.ft.create('idx:users', {
+  '$.name': {
+    type: SchemaFieldTypes.TEXT,
+    SORTABLE: 'UNF'
+  },
+  '$.age': {
+    type: SchemaFieldTypes.NUMERIC,
+    AS: 'age'
+  },
+  '$.coins': {
+    type: SchemaFieldTypes.NUMERIC,
+    AS: 'coins'
+  }
+}, {
+  ON: 'JSON',
+  PREFIX: 'noderedis:users'
+});
+```
+
+Note that we're using JSON Path to specify where the fields to index are in our JSON documents, and the `AS` clause to define a name/alias for each field.  We'll use these when writing queries.
+
+#### Querying the Index
+
+Now we have an index and some data stored as JSON documents in Redis (see the [JSON package documentation](https://github.com/redis/node-redis/tree/master/packages/json) for examples of how to store JSON), we can write some queries...
+
+We'll use the [RediSearch query language](https://oss.redis.com/redisearch/Query_Syntax/) and [`FT.SEARCH`](https://oss.redis.com/redisearch/Commands/#ftsearch) command.  Here's a query to find users under the age of 30:
+
+```javascript
+await client.ft.search('idx:users', '@age:[0 30]');
+```

package/dist/commands/AGGREGATE.d.ts

@@ -0,0 +1,114 @@
+import { RedisCommandArgument, RedisCommandArguments } from '@redis/client/dist/lib/commands';
+import { Params, PropertyName, SortByProperty } from '.';
+export declare enum AggregateSteps {
+    GROUPBY = "GROUPBY",
+    SORTBY = "SORTBY",
+    APPLY = "APPLY",
+    LIMIT = "LIMIT",
+    FILTER = "FILTER"
+}
+interface AggregateStep<T extends AggregateSteps> {
+    type: T;
+}
+export declare enum AggregateGroupByReducers {
+    COUNT = "COUNT",
+    COUNT_DISTINCT = "COUNT_DISTINCT",
+    COUNT_DISTINCTISH = "COUNT_DISTINCTISH",
+    SUM = "SUM",
+    MIN = "MIN",
+    MAX = "MAX",
+    AVG = "AVG",
+    STDDEV = "STDDEV",
+    QUANTILE = "QUANTILE",
+    TOLIST = "TOLIST",
+    TO_LIST = "TOLIST",
+    FIRST_VALUE = "FIRST_VALUE",
+    RANDOM_SAMPLE = "RANDOM_SAMPLE"
+}
+interface GroupByReducer<T extends AggregateGroupByReducers> {
+    type: T;
+    AS?: string;
+}
+declare type CountReducer = GroupByReducer<AggregateGroupByReducers.COUNT>;
+interface CountDistinctReducer extends GroupByReducer<AggregateGroupByReducers.COUNT_DISTINCT> {
+    property: PropertyName;
+}
+interface CountDistinctishReducer extends GroupByReducer<AggregateGroupByReducers.COUNT_DISTINCTISH> {
+    property: PropertyName;
+}
+interface SumReducer extends GroupByReducer<AggregateGroupByReducers.SUM> {
+    property: PropertyName;
+}
+interface MinReducer extends GroupByReducer<AggregateGroupByReducers.MIN> {
+    property: PropertyName;
+}
+interface MaxReducer extends GroupByReducer<AggregateGroupByReducers.MAX> {
+    property: PropertyName;
+}
+interface AvgReducer extends GroupByReducer<AggregateGroupByReducers.AVG> {
+    property: PropertyName;
+}
+interface StdDevReducer extends GroupByReducer<AggregateGroupByReducers.STDDEV> {
+    property: PropertyName;
+}
+interface QuantileReducer extends GroupByReducer<AggregateGroupByReducers.QUANTILE> {
+    property: PropertyName;
+    quantile: number;
+}
+interface ToListReducer extends GroupByReducer<AggregateGroupByReducers.TOLIST> {
+    property: PropertyName;
+}
+interface FirstValueReducer extends GroupByReducer<AggregateGroupByReducers.FIRST_VALUE> {
+    property: PropertyName;
+    BY?: PropertyName | {
+        property: PropertyName;
+        direction?: 'ASC' | 'DESC';
+    };
+}
+interface RandomSampleReducer extends GroupByReducer<AggregateGroupByReducers.RANDOM_SAMPLE> {
+    property: PropertyName;
+    sampleSize: number;
+}
+declare type GroupByReducers = CountReducer | CountDistinctReducer | CountDistinctishReducer | SumReducer | MinReducer | MaxReducer | AvgReducer | StdDevReducer | QuantileReducer | ToListReducer | FirstValueReducer | RandomSampleReducer;
+interface GroupByStep extends AggregateStep<AggregateSteps.GROUPBY> {
+    properties?: PropertyName | Array<PropertyName>;
+    REDUCE: GroupByReducers | Array<GroupByReducers>;
+}
+interface SortStep extends AggregateStep<AggregateSteps.SORTBY> {
+    BY: SortByProperty | Array<SortByProperty>;
+    MAX?: number;
+}
+interface ApplyStep extends AggregateStep<AggregateSteps.APPLY> {
+    expression: string;
+    AS: string;
+}
+interface LimitStep extends AggregateStep<AggregateSteps.LIMIT> {
+    from: number;
+    size: number;
+}
+interface FilterStep extends AggregateStep<AggregateSteps.FILTER> {
+    expression: string;
+}
+declare type LoadField = PropertyName | {
+    identifier: PropertyName;
+    AS?: string;
+};
+export interface AggregateOptions {
+    VERBATIM?: true;
+    LOAD?: LoadField | Array<LoadField>;
+    STEPS?: Array<GroupByStep | SortStep | ApplyStep | LimitStep | FilterStep>;
+    PARAMS?: Params;
+    DIALECT?: number;
+}
+export declare function transformArguments(index: string, query: string, options?: AggregateOptions): RedisCommandArguments;
+export declare function pushAggregatehOptions(args: RedisCommandArguments, options?: AggregateOptions): RedisCommandArguments;
+export declare type AggregateRawReply = [
+    total: number,
+    ...results: Array<Array<RedisCommandArgument>>
+];
+export interface AggregateReply {
+    total: number;
+    results: Array<Record<string, RedisCommandArgument>>;
+}
+export declare function transformReply(rawReply: AggregateRawReply): AggregateReply;
+export {};

package/dist/commands/AGGREGATE.js

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformReply = exports.pushAggregatehOptions = exports.transformArguments = exports.AggregateGroupByReducers = exports.AggregateSteps = void 0;
+const generic_transformers_1 = require("@redis/client/dist/lib/commands/generic-transformers");
+const _1 = require(".");
+var AggregateSteps;
+(function (AggregateSteps) {
+    AggregateSteps["GROUPBY"] = "GROUPBY";
+    AggregateSteps["SORTBY"] = "SORTBY";
+    AggregateSteps["APPLY"] = "APPLY";
+    AggregateSteps["LIMIT"] = "LIMIT";
+    AggregateSteps["FILTER"] = "FILTER";
+})(AggregateSteps = exports.AggregateSteps || (exports.AggregateSteps = {}));
+var AggregateGroupByReducers;
+(function (AggregateGroupByReducers) {
+    AggregateGroupByReducers["COUNT"] = "COUNT";
+    AggregateGroupByReducers["COUNT_DISTINCT"] = "COUNT_DISTINCT";
+    AggregateGroupByReducers["COUNT_DISTINCTISH"] = "COUNT_DISTINCTISH";
+    AggregateGroupByReducers["SUM"] = "SUM";
+    AggregateGroupByReducers["MIN"] = "MIN";
+    AggregateGroupByReducers["MAX"] = "MAX";
+    AggregateGroupByReducers["AVG"] = "AVG";
+    AggregateGroupByReducers["STDDEV"] = "STDDEV";
+    AggregateGroupByReducers["QUANTILE"] = "QUANTILE";
+    AggregateGroupByReducers["TOLIST"] = "TOLIST";
+    AggregateGroupByReducers["TO_LIST"] = "TOLIST";
+    AggregateGroupByReducers["FIRST_VALUE"] = "FIRST_VALUE";
+    AggregateGroupByReducers["RANDOM_SAMPLE"] = "RANDOM_SAMPLE";
+})(AggregateGroupByReducers = exports.AggregateGroupByReducers || (exports.AggregateGroupByReducers = {}));
+function transformArguments(index, query, options) {
+    return pushAggregatehOptions(['FT.AGGREGATE', index, query], options);
+}
+exports.transformArguments = transformArguments;
+function pushAggregatehOptions(args, options) {
+    if (options?.VERBATIM) {
+        args.push('VERBATIM');
+    }
+    if (options?.LOAD) {
+        args.push('LOAD');
+        (0, _1.pushArgumentsWithLength)(args, () => {
+            if (Array.isArray(options.LOAD)) {
+                for (const load of options.LOAD) {
+                    pushLoadField(args, load);
+                }
+            }
+            else {
+                pushLoadField(args, options.LOAD);
+            }
+        });
+    }
+    if (options?.STEPS) {
+        for (const step of options.STEPS) {
+            switch (step.type) {
+                case AggregateSteps.GROUPBY:
+                    args.push('GROUPBY');
+                    if (!step.properties) {
+                        args.push('0');
+                    }
+                    else {
+                        (0, generic_transformers_1.pushVerdictArgument)(args, step.properties);
+                    }
+                    if (Array.isArray(step.REDUCE)) {
+                        for (const reducer of step.REDUCE) {
+                            pushGroupByReducer(args, reducer);
+                        }
+                    }
+                    else {
+                        pushGroupByReducer(args, step.REDUCE);
+                    }
+                    break;
+                case AggregateSteps.SORTBY:
+                    (0, _1.pushSortByArguments)(args, 'SORTBY', step.BY);
+                    if (step.MAX) {
+                        args.push('MAX', step.MAX.toString());
+                    }
+                    break;
+                case AggregateSteps.APPLY:
+                    args.push('APPLY', step.expression, 'AS', step.AS);
+                    break;
+                case AggregateSteps.LIMIT:
+                    args.push('LIMIT', step.from.toString(), step.size.toString());
+                    break;
+                case AggregateSteps.FILTER:
+                    args.push('FILTER', step.expression);
+                    break;
+            }
+        }
+    }
+    (0, _1.pushParamsArgs)(args, options?.PARAMS);
+    if (options?.DIALECT) {
+        args.push('DIALECT', options.DIALECT.toString());
+    }
+    return args;
+}
+exports.pushAggregatehOptions = pushAggregatehOptions;
+function pushLoadField(args, toLoad) {
+    if (typeof toLoad === 'string') {
+        args.push(toLoad);
+    }
+    else {
+        args.push(toLoad.identifier);
+        if (toLoad.AS) {
+            args.push('AS', toLoad.AS);
+        }
+    }
+}
+function pushGroupByReducer(args, reducer) {
+    args.push('REDUCE', reducer.type);
+    switch (reducer.type) {
+        case AggregateGroupByReducers.COUNT:
+            args.push('0');
+            break;
+        case AggregateGroupByReducers.COUNT_DISTINCT:
+        case AggregateGroupByReducers.COUNT_DISTINCTISH:
+        case AggregateGroupByReducers.SUM:
+        case AggregateGroupByReducers.MIN:
+        case AggregateGroupByReducers.MAX:
+        case AggregateGroupByReducers.AVG:
+        case AggregateGroupByReducers.STDDEV:
+        case AggregateGroupByReducers.TOLIST:
+            args.push('1', reducer.property);
+            break;
+        case AggregateGroupByReducers.QUANTILE:
+            args.push('2', reducer.property, reducer.quantile.toString());
+            break;
+        case AggregateGroupByReducers.FIRST_VALUE: {
+            (0, _1.pushArgumentsWithLength)(args, () => {
+                args.push(reducer.property);
+                if (reducer.BY) {
+                    args.push('BY');
+                    if (typeof reducer.BY === 'string') {
+                        args.push(reducer.BY);
+                    }
+                    else {
+                        args.push(reducer.BY.property);
+                        if (reducer.BY.direction) {
+                            args.push(reducer.BY.direction);
+                        }
+                    }
+                }
+            });
+            break;
+        }
+        case AggregateGroupByReducers.RANDOM_SAMPLE:
+            args.push('2', reducer.property, reducer.sampleSize.toString());
+            break;
+    }
+    if (reducer.AS) {
+        args.push('AS', reducer.AS);
+    }
+}
+function transformReply(rawReply) {
+    const results = [];
+    for (let i = 1; i < rawReply.length; i++) {
+        results.push((0, generic_transformers_1.transformTuplesReply)(rawReply[i]));
+    }
+    return {
+        total: rawReply[0],
+        results
+    };
+}
+exports.transformReply = transformReply;

package/dist/commands/ALIASADD.d.ts

@@ -0,0 +1,2 @@
+export declare function transformArguments(name: string, index: string): Array<string>;
+export declare function transformReply(): 'OK';

package/dist/commands/ALIASADD.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = void 0;
+function transformArguments(name, index) {
+    return ['FT.ALIASADD', name, index];
+}
+exports.transformArguments = transformArguments;

package/dist/commands/ALIASDEL.d.ts

@@ -0,0 +1,2 @@
+export declare function transformArguments(name: string, index: string): Array<string>;
+export declare function transformReply(): 'OK';

package/dist/commands/ALIASDEL.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = void 0;
+function transformArguments(name, index) {
+    return ['FT.ALIASDEL', name, index];
+}
+exports.transformArguments = transformArguments;

package/dist/commands/ALIASUPDATE.d.ts

@@ -0,0 +1,2 @@
+export declare function transformArguments(name: string, index: string): Array<string>;
+export declare function transformReply(): 'OK';

package/dist/commands/ALIASUPDATE.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = void 0;
+function transformArguments(name, index) {
+    return ['FT.ALIASUPDATE', name, index];
+}
+exports.transformArguments = transformArguments;

package/dist/commands/ALTER.d.ts

@@ -0,0 +1,3 @@
+import { RediSearchSchema } from '.';
+export declare function transformArguments(index: string, schema: RediSearchSchema): Array<string>;
+export declare function transformReply(): 'OK';

package/dist/commands/ALTER.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = void 0;
+const _1 = require(".");
+function transformArguments(index, schema) {
+    const args = ['FT.ALTER', index, 'SCHEMA', 'ADD'];
+    (0, _1.pushSchema)(args, schema);
+    return args;
+}
+exports.transformArguments = transformArguments;

package/dist/commands/CONFIG_GET.d.ts

@@ -0,0 +1,6 @@
+export declare function transformArguments(option: string): string[];
+interface ConfigGetReply {
+    [option: string]: string | null;
+}
+export declare function transformReply(rawReply: Array<[string, string | null]>): ConfigGetReply;
+export {};

package/dist/commands/CONFIG_GET.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformReply = exports.transformArguments = void 0;
+function transformArguments(option) {
+    return ['FT.CONFIG', 'GET', option];
+}
+exports.transformArguments = transformArguments;
+function transformReply(rawReply) {
+    const transformedReply = Object.create(null);
+    for (const [key, value] of rawReply) {
+        transformedReply[key] = value;
+    }
+    return transformedReply;
+}
+exports.transformReply = transformReply;

package/dist/commands/CONFIG_SET.d.ts

@@ -0,0 +1,2 @@
+export declare function transformArguments(option: string, value: string): Array<string>;
+export declare function transformReply(): 'OK';

package/dist/commands/CONFIG_SET.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = void 0;
+function transformArguments(option, value) {
+    return ['FT.CONFIG', 'SET', option, value];
+}
+exports.transformArguments = transformArguments;

package/dist/commands/CREATE.d.ts

@@ -0,0 +1,21 @@
+import { RedisSearchLanguages, PropertyName, RediSearchSchema } from '.';
+interface CreateOptions {
+    ON?: 'HASH' | 'JSON';
+    PREFIX?: string | Array<string>;
+    FILTER?: string;
+    LANGUAGE?: RedisSearchLanguages;
+    LANGUAGE_FIELD?: PropertyName;
+    SCORE?: number;
+    SCORE_FIELD?: PropertyName;
+    MAXTEXTFIELDS?: true;
+    TEMPORARY?: number;
+    NOOFFSETS?: true;
+    NOHL?: true;
+    NOFIELDS?: true;
+    NOFREQS?: true;
+    SKIPINITIALSCAN?: true;
+    STOPWORDS?: string | Array<string>;
+}
+export declare function transformArguments(index: string, schema: RediSearchSchema, options?: CreateOptions): Array<string>;
+export declare function transformReply(): 'OK';
+export {};

package/dist/commands/CREATE.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = void 0;
+const generic_transformers_1 = require("@redis/client/dist/lib/commands/generic-transformers");
+const _1 = require(".");
+function transformArguments(index, schema, options) {
+    const args = ['FT.CREATE', index];
+    if (options?.ON) {
+        args.push('ON', options.ON);
+    }
+    (0, generic_transformers_1.pushOptionalVerdictArgument)(args, 'PREFIX', options?.PREFIX);
+    if (options?.FILTER) {
+        args.push('FILTER', options.FILTER);
+    }
+    if (options?.LANGUAGE) {
+        args.push('LANGUAGE', options.LANGUAGE);
+    }
+    if (options?.LANGUAGE_FIELD) {
+        args.push('LANGUAGE_FIELD', options.LANGUAGE_FIELD);
+    }
+    if (options?.SCORE) {
+        args.push('SCORE', options.SCORE.toString());
+    }
+    if (options?.SCORE_FIELD) {
+        args.push('SCORE_FIELD', options.SCORE_FIELD);
+    }
+    // if (options?.PAYLOAD_FIELD) {
+    //     args.push('PAYLOAD_FIELD', options.PAYLOAD_FIELD);
+    // }
+    if (options?.MAXTEXTFIELDS) {
+        args.push('MAXTEXTFIELDS');
+    }
+    if (options?.TEMPORARY) {
+        args.push('TEMPORARY', options.TEMPORARY.toString());
+    }
+    if (options?.NOOFFSETS) {
+        args.push('NOOFFSETS');
+    }
+    if (options?.NOHL) {
+        args.push('NOHL');
+    }
+    if (options?.NOFIELDS) {
+        args.push('NOFIELDS');
+    }
+    if (options?.NOFREQS) {
+        args.push('NOFREQS');
+    }
+    if (options?.SKIPINITIALSCAN) {
+        args.push('SKIPINITIALSCAN');
+    }
+    (0, generic_transformers_1.pushOptionalVerdictArgument)(args, 'STOPWORDS', options?.STOPWORDS);
+    args.push('SCHEMA');
+    (0, _1.pushSchema)(args, schema);
+    return args;
+}
+exports.transformArguments = transformArguments;

package/dist/commands/DICTADD.d.ts

@@ -0,0 +1,3 @@
+import { RedisCommandArguments } from '@redis/client/dist/lib/commands';
+export declare function transformArguments(dictionary: string, term: string | Array<string>): RedisCommandArguments;
+export declare function transformReply(): number;

package/dist/commands/DICTADD.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = void 0;
+const generic_transformers_1 = require("@redis/client/dist/lib/commands/generic-transformers");
+function transformArguments(dictionary, term) {
+    return (0, generic_transformers_1.pushVerdictArguments)(['FT.DICTADD', dictionary], term);
+}
+exports.transformArguments = transformArguments;

package/dist/commands/DICTDEL.d.ts

@@ -0,0 +1,3 @@
+import { RedisCommandArguments } from '@redis/client/dist/lib/commands';
+export declare function transformArguments(dictionary: string, term: string | Array<string>): RedisCommandArguments;
+export declare function transformReply(): number;

package/dist/commands/DICTDEL.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = void 0;
+const generic_transformers_1 = require("@redis/client/dist/lib/commands/generic-transformers");
+function transformArguments(dictionary, term) {
+    return (0, generic_transformers_1.pushVerdictArguments)(['FT.DICTDEL', dictionary], term);
+}
+exports.transformArguments = transformArguments;

package/dist/commands/DICTDUMP.d.ts

@@ -0,0 +1,2 @@
+export declare function transformArguments(dictionary: string): Array<string>;
+export declare function transformReply(): Array<string>;

package/dist/commands/DICTDUMP.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = void 0;
+function transformArguments(dictionary) {
+    return ['FT.DICTDUMP', dictionary];
+}
+exports.transformArguments = transformArguments;

package/dist/commands/DROPINDEX.d.ts

@@ -0,0 +1,6 @@
+interface DropIndexOptions {
+    DD?: true;
+}
+export declare function transformArguments(index: string, options?: DropIndexOptions): Array<string>;
+export declare function transformReply(): 'OK';
+export {};

package/dist/commands/DROPINDEX.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = void 0;
+function transformArguments(index, options) {
+    const args = ['FT.DROPINDEX', index];
+    if (options?.DD) {
+        args.push('DD');
+    }
+    return args;
+}
+exports.transformArguments = transformArguments;

package/dist/commands/EXPLAIN.d.ts

@@ -0,0 +1,9 @@
+import { Params } from ".";
+export declare const IS_READ_ONLY = true;
+interface ExplainOptions {
+    PARAMS?: Params;
+    DIALECT?: number;
+}
+export declare function transformArguments(index: string, query: string, options?: ExplainOptions): Array<string>;
+export declare function transformReply(): string;
+export {};

package/dist/commands/EXPLAIN.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = exports.IS_READ_ONLY = void 0;
+const _1 = require(".");
+exports.IS_READ_ONLY = true;
+function transformArguments(index, query, options) {
+    const args = ['FT.EXPLAIN', index, query];
+    (0, _1.pushParamsArgs)(args, options?.PARAMS);
+    if (options?.DIALECT) {
+        args.push('DIALECT', options.DIALECT.toString());
+    }
+    return args;
+}
+exports.transformArguments = transformArguments;

package/dist/commands/EXPLAINCLI.d.ts

@@ -0,0 +1,3 @@
+export declare const IS_READ_ONLY = true;
+export declare function transformArguments(index: string, query: string): Array<string>;
+export declare function transformReply(): Array<string>;