Node: Convert classes to types #2005
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,13 +4,14 @@ | |
|
|
||
| import { createLeakedStringVec, MAX_REQUEST_ARGS_LEN } from "glide-rs"; | ||
| import Long from "long"; | ||
|
|
||
| /* eslint-disable-next-line @typescript-eslint/no-unused-vars */ | ||
| import { BaseClient } from "src/BaseClient"; | ||
| /* eslint-disable-next-line @typescript-eslint/no-unused-vars */ | ||
| import { GlideClient } from "src/GlideClient"; | ||
| /* eslint-disable-next-line @typescript-eslint/no-unused-vars */ | ||
| import { GlideClusterClient } from "src/GlideClusterClient"; | ||
| import { command_request } from "./ProtobufMessage"; | ||
|
|
||
| import RequestType = command_request.RequestType; | ||
|
|
||
|
|
@@ -976,21 +977,25 @@ export function createTTL(key: string): command_request.Command { | |
| return createCommand(RequestType.TTL, [key]); | ||
| } | ||
|
|
||
| /** | ||
| * Options for updating elements of a sorted set key. | ||
|
GumpacG marked this conversation as resolved.
|
||
| */ | ||
| export enum UpdateByScore { | ||
| /** Only update existing elements if the new score is less than the current score. */ | ||
| LESS_THAN = "LT", | ||
| /** Only update existing elements if the new score is greater than the current score. */ | ||
| GREATER_THAN = "GT", | ||
| } | ||
|
|
||
| export type ZAddOptions = { | ||
| /** | ||
| * Options for handling existing members. | ||
| */ | ||
| conditionalChange?: ConditionalChange; | ||
| /** | ||
| * Options for updating scores. | ||
| */ | ||
| updateOptions?: UpdateByScore; | ||
| /** | ||
| * Modify the return value from the number of new elements added, to the total number of elements changed. | ||
| */ | ||
|
|
@@ -1009,22 +1014,22 @@ export function createZAdd( | |
| let args = [key]; | ||
|
|
||
| if (options) { | ||
| if (options.conditionalChange) { | ||
| if ( | ||
| options.conditionalChange === | ||
| ConditionalChange.ONLY_IF_DOES_NOT_EXIST && | ||
| options.updateOptions | ||
| ) { | ||
| throw new Error( | ||
| `The GT, LT, and NX options are mutually exclusive. Cannot choose both ${options.updateOptions} and NX.`, | ||
| ); | ||
| } | ||
|
|
||
| args.push(options.conditionalChange); | ||
| } | ||
|
|
||
| if (options.updateOptions) { | ||
| args.push(options.updateOptions); | ||
| } | ||
|
|
||
| if (options.changed) { | ||
|
|
@@ -1694,6 +1699,27 @@ export function createFunctionLoad( | |
| return createCommand(RequestType.FunctionLoad, args); | ||
| } | ||
|
|
||
| /** | ||
| * Represents offsets specifying a string interval to analyze in the {@link BaseClient.bitcount|bitcount} command. The offsets are | ||
| * zero-based indexes, with `0` being the first index of the string, `1` being the next index and so on. | ||
| * The offsets can also be negative numbers indicating offsets starting at the end of the string, with `-1` being | ||
| * the last index of the string, `-2` being the penultimate, and so on. | ||
| * | ||
| * See https://valkey.io/commands/bitcount/ for more details. | ||
| */ | ||
| export type BitOffsetOptions = { | ||
| /** The starting offset index. */ | ||
| start: number; | ||
| /** The ending offset index. */ | ||
| end: number; | ||
| /** | ||
| * The index offset type. This option can only be specified if you are using server version 7.0.0 or above. | ||
| * Could be either {@link BitmapIndexType.BYTE} or {@link BitmapIndexType.BIT}. | ||
| * If no index type is provided, the indexes will be assumed to be byte indexes. | ||
| */ | ||
| indexType?: BitmapIndexType; | ||
| }; | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
|
|
@@ -1702,7 +1728,13 @@ export function createBitCount( | |
| options?: BitOffsetOptions, | ||
| ): command_request.Command { | ||
| const args = [key]; | ||
|
|
||
| if (options) { | ||
| args.push(options.start.toString()); | ||
| args.push(options.end.toString()); | ||
| if (options.indexType) args.push(options.indexType); | ||
| } | ||
|
|
||
| return createCommand(RequestType.BitCount, args); | ||
| } | ||
|
|
||
|
|
@@ -1747,6 +1779,24 @@ export function createBitPos( | |
| return createCommand(RequestType.BitPos, args); | ||
| } | ||
|
|
||
| /** | ||
| * Defines flushing mode for {@link GlideClient.flushall}, {@link GlideClusterClient.flushall}, | ||
| * {@link GlideClient.functionFlush}, {@link GlideClusterClient.functionFlush}, | ||
| * {@link GlideClient.flushdb} and {@link GlideClusterClient.flushdb} commands. | ||
| * | ||
|
GumpacG marked this conversation as resolved.
|
||
| * See https://valkey.io/commands/flushall/ and https://valkey.io/commands/flushdb/ for details. | ||
| */ | ||
| export enum FlushMode { | ||
| /** | ||
| * Flushes synchronously. | ||
| * | ||
| * since Valkey version 6.2.0. | ||
| */ | ||
| SYNC = "SYNC", | ||
| /** Flushes asynchronously. */ | ||
| ASYNC = "ASYNC", | ||
| } | ||
|
|
||
| export type StreamReadOptions = { | ||
| /** | ||
| * If set, the read request will block for the set amount of milliseconds or | ||
|
|
@@ -1932,6 +1982,20 @@ export function createFlushDB(mode?: FlushMode): command_request.Command { | |
| } | ||
| } | ||
|
|
||
| /** | ||
| * Optional arguments to LPOS command. | ||
| * | ||
| * See https://valkey.io/commands/lpos/ for more details. | ||
| */ | ||
| export type LPosOptions = { | ||
| /** The rank of the match to return. */ | ||
| rank?: number; | ||
| /** The specific number of matching indices from a list. */ | ||
| count?: number; | ||
| /** The maximum number of comparisons to make between the element and the items in the list. */ | ||
| maxLength?: number; | ||
| }; | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
|
|
@@ -1940,10 +2004,23 @@ export function createLPos( | |
| element: string, | ||
| options?: LPosOptions, | ||
| ): command_request.Command { | ||
| const args: string[] = [key, element]; | ||
|
|
||
| if (options) { | ||
| if (options.rank !== undefined) { | ||
|
Contributor
There was a problem hiding this comment. Can't you just use
Contributor
Author
There was a problem hiding this comment. We can do that with non-number types however, we can't do that with
Contributor
There was a problem hiding this comment. Be careful. The string value |
||
| args.push("RANK"); | ||
| args.push(options.rank.toString()); | ||
| } | ||
|
|
||
| if (options.count !== undefined) { | ||
| args.push("COUNT"); | ||
| args.push(options.count.toString()); | ||
| } | ||
|
|
||
| if (options.maxLength !== undefined) { | ||
| args.push("MAXLEN"); | ||
| args.push(options.maxLength.toString()); | ||
| } | ||
| } | ||
|
|
||
| return createCommand(RequestType.LPos, args); | ||
|
|
@@ -1956,6 +2033,48 @@ export function createDBSize(): command_request.Command { | |
| return createCommand(RequestType.DBSize, []); | ||
| } | ||
|
|
||
| /** | ||
| * An optional condition to the {@link BaseClient.geoadd} command. | ||
| */ | ||
| export enum ConditionalChange { | ||
| /** | ||
| * Only update elements that already exist. Don't add new elements. Equivalent to `XX` in the Valkey API. | ||
| */ | ||
| ONLY_IF_EXISTS = "XX", | ||
|
|
||
| /** | ||
| * Only add new elements. Don't update already existing elements. Equivalent to `NX` in the Valkey API. | ||
| */ | ||
| ONLY_IF_DOES_NOT_EXIST = "NX", | ||
| } | ||
|
|
||
| /** | ||
| * Represents a geographic position defined by longitude and latitude. | ||
| * The exact limits, as specified by `EPSG:900913 / EPSG:3785 / OSGEO:41001` are the | ||
| * following: | ||
| * | ||
| * Valid longitudes are from `-180` to `180` degrees. | ||
| * Valid latitudes are from `-85.05112878` to `85.05112878` degrees. | ||
| */ | ||
| export type GeospatialData = { | ||
| /** The longitude coordinate. */ | ||
| longitude: number; | ||
| /** The latitude coordinate. */ | ||
| latitude: number; | ||
| }; | ||
|
|
||
| /** | ||
| * Optional arguments for the GeoAdd command. | ||
| * | ||
| * See https://valkey.io/commands/geoadd/ for more details. | ||
| */ | ||
| export type GeoAddOptions = { | ||
| /** Options for handling existing members. See {@link ConditionalChange}. */ | ||
| updateMode?: ConditionalChange; | ||
| /** If `true`, returns the count of changed elements instead of new elements added. */ | ||
| changed?: boolean; | ||
| }; | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
|
|
@@ -1967,11 +2086,20 @@ export function createGeoAdd( | |
| let args: string[] = [key]; | ||
|
|
||
| if (options) { | ||
| if (options.updateMode) { | ||
| args.push(options.updateMode); | ||
| } | ||
|
|
||
| if (options.changed) { | ||
| args.push("CH"); | ||
|
Contributor
There was a problem hiding this comment. do we have a place to put string constants?
Contributor
Author
There was a problem hiding this comment. Not currently, I think if we want to do this, it should be a part of a different PR as we may want to convert other types with string constants to enums. Would potentially be big enough on it's own. |
||
| } | ||
| } | ||
|
|
||
| membersToGeospatialData.forEach((coord, member) => { | ||
| args = args.concat([ | ||
| coord.longitude.toString(), | ||
| coord.latitude.toString(), | ||
| ]); | ||
| args.push(member); | ||
| }); | ||
| return createCommand(RequestType.GeoAdd, args); | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.