mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-05-10 09:40:21 +08:00
Add types for memjs (#27802)
This commit is contained in:
老雷
410
types/memjs/index.d.ts
vendored
Normal file
410
types/memjs/index.d.ts
vendored
Normal file
@@ -0,0 +1,410 @@
|
||||
// Type definitions for memjs 1.2
|
||||
// Project: http://github.com/memcachier/memjs
|
||||
// Definitions by: Zongmin Lei <https://github.com/leizongmin>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
// TypeScript Version: 2.1
|
||||
|
||||
/// <reference types="node" />
|
||||
|
||||
export interface ClientOptions {
|
||||
/**
|
||||
* `failoverTime` - how much to wait until retring a failed server. Default
|
||||
* is 60 seconds.
|
||||
*/
|
||||
failoverTime?: number;
|
||||
/**
|
||||
* `retries` - the number of times to retry an operation in lieu of failures
|
||||
* (default 2)
|
||||
*/
|
||||
retries?: number;
|
||||
/**
|
||||
* `retry_delay` - default is 0.2
|
||||
*/
|
||||
retry_delay?: number;
|
||||
/**
|
||||
* `expires` - the default expiration in seconds to use (default 0 - never
|
||||
* expire). If `expires` is greater than 30 days (60 x 60 x 24 x 30), it is
|
||||
* treated as a UNIX time (number of seconds since January 1, 1970).
|
||||
*/
|
||||
expires?: number;
|
||||
/**
|
||||
* `logger` - a logger object that responds to `log(string)` method calls.
|
||||
*/
|
||||
logger?: {
|
||||
log(...args: any[]): void;
|
||||
};
|
||||
}
|
||||
export class Client {
|
||||
/**
|
||||
* Creates a new client given an optional config string and optional hash of
|
||||
* options. The config string should be of the form:
|
||||
*
|
||||
* "[user:pass@]server1[:11211],[user:pass@]server2[:11211],..."
|
||||
*
|
||||
* If the argument is not given, fallback on the `MEMCACHIER_SERVERS` environment
|
||||
* variable, `MEMCACHE_SERVERS` environment variable or `"localhost:11211"`.
|
||||
*
|
||||
* The options hash may contain the options:
|
||||
*
|
||||
* * `retries` - the number of times to retry an operation in lieu of failures
|
||||
* (default 2)
|
||||
* * `expires` - the default expiration in seconds to use (default 0 - never
|
||||
* expire). If `expires` is greater than 30 days (60 x 60 x 24 x 30), it is
|
||||
* treated as a UNIX time (number of seconds since January 1, 1970).
|
||||
* * `logger` - a logger object that responds to `log(string)` method calls.
|
||||
* * `failover` - whether to failover to next server. Defaults to false.
|
||||
* * `failoverTime` - how much to wait until retring a failed server. Default
|
||||
* is 60 seconds.
|
||||
*
|
||||
* ~~~~
|
||||
* log(msg1[, msg2[, msg3[...]]])
|
||||
* ~~~~
|
||||
*
|
||||
* Defaults to `console`.
|
||||
*
|
||||
* Or options for the servers including:
|
||||
* * `username` and `password` for fallback SASL authentication credentials.
|
||||
* * `timeout` in seconds to determine failure for operations. Default is 0.5
|
||||
* seconds.
|
||||
* * 'conntimeout' in seconds to connection failure. Default is twice the value
|
||||
* of `timeout`.
|
||||
* * `keepAlive` whether to enable keep-alive functionality. Defaults to false.
|
||||
* * `keepAliveDelay` in seconds to the initial delay before the first keepalive
|
||||
* probe is sent on an idle socket. Defaults is 30 seconds.
|
||||
*/
|
||||
static create(serversStr?: string, options?: ClientOptions): Client;
|
||||
|
||||
servers: string[];
|
||||
|
||||
/**
|
||||
* Client initializer takes a list of Servers and an options dictionary. See Client.create for details.
|
||||
* @param servers
|
||||
* @param options
|
||||
*/
|
||||
constructor(servers: string, options?: ClientOptions);
|
||||
|
||||
/**
|
||||
* Chooses the server to talk to by hashing the given key.
|
||||
* @param key
|
||||
*/
|
||||
server(key: string): string;
|
||||
|
||||
/**
|
||||
* GET
|
||||
*
|
||||
* Retrieves the value at the given key in memcache.
|
||||
*
|
||||
* The callback signature is:
|
||||
*
|
||||
* callback(err, value, flags)
|
||||
*
|
||||
* _value_ and _flags_ are both `Buffer`s. If the key is not found, the
|
||||
* callback is invoked with null for both arguments and no error
|
||||
* @param key
|
||||
* @param callback
|
||||
*/
|
||||
get(
|
||||
key: string,
|
||||
callback: (err?: Error | null, value?: Buffer, flags?: Buffer) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* SET
|
||||
*
|
||||
* Sets the given _key_ and _value_ in memcache.
|
||||
*
|
||||
* The options dictionary takes:
|
||||
* * _expires_: overrides the default expiration (see `Client.create`) for this
|
||||
* particular key-value pair.
|
||||
*
|
||||
* The callback signature is:
|
||||
*
|
||||
* callback(err, success)
|
||||
* @param key
|
||||
* @param value
|
||||
* @param options
|
||||
* @param callback
|
||||
*/
|
||||
set(
|
||||
key: string,
|
||||
value: string | Buffer,
|
||||
options: { expires?: number },
|
||||
callback: (err?: Error | null, success?: boolean) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* ADD
|
||||
*
|
||||
* Adds the given _key_ and _value_ to memcache. The operation only succeeds
|
||||
* if the key is not already set.
|
||||
*
|
||||
* The options dictionary takes:
|
||||
* * _expires_: overrides the default expiration (see `Client.create`) for this
|
||||
* particular key-value pair.
|
||||
*
|
||||
* The callback signature is:
|
||||
*
|
||||
* callback(err, success)
|
||||
* @param key
|
||||
* @param value
|
||||
* @param options
|
||||
* @param callback
|
||||
*/
|
||||
add(
|
||||
key: string,
|
||||
value: string | Buffer,
|
||||
options: { expires?: number },
|
||||
callback: (err?: Error | null, success?: boolean) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* REPLACE
|
||||
*
|
||||
* Replaces the given _key_ and _value_ to memcache. The operation only succeeds
|
||||
* if the key is already present.
|
||||
*
|
||||
* The options dictionary takes:
|
||||
* * _expires_: overrides the default expiration (see `Client.create`) for this
|
||||
* particular key-value pair.
|
||||
*
|
||||
* The callback signature is:
|
||||
*
|
||||
* callback(err, success)
|
||||
* @param key
|
||||
* @param value
|
||||
* @param options
|
||||
* @param callback
|
||||
*/
|
||||
replace(
|
||||
key: string,
|
||||
value: string | Buffer,
|
||||
options: { expires?: number },
|
||||
callback: (err?: Error | null, success?: boolean) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* DELETE
|
||||
*
|
||||
* Deletes the given _key_ from memcache. The operation only succeeds
|
||||
* if the key is already present.
|
||||
*
|
||||
* The callback signature is:
|
||||
*
|
||||
* callback(err, success)
|
||||
* @param key
|
||||
* @param callback
|
||||
*/
|
||||
delete(
|
||||
key: string,
|
||||
callback: (err?: Error | null, success?: boolean) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* INCREMENT
|
||||
*
|
||||
* Increments the given _key_ in memcache.
|
||||
*
|
||||
* The options dictionary takes:
|
||||
* * _initial_: the value for the key if not already present, defaults to 0.
|
||||
* * _expires_: overrides the default expiration (see `Client.create`) for this
|
||||
* particular key-value pair.
|
||||
*
|
||||
* The callback signature is:
|
||||
*
|
||||
* callback(err, success, value)
|
||||
* @param key
|
||||
* @param amount
|
||||
* @param options
|
||||
* @param callback
|
||||
*/
|
||||
increment(
|
||||
key: string,
|
||||
amount: number,
|
||||
options: { initial?: number; expires?: number },
|
||||
callback: (
|
||||
err?: Error | null,
|
||||
success?: boolean,
|
||||
value?: number
|
||||
) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* DECREMENT
|
||||
*
|
||||
* Decrements the given _key_ in memcache.
|
||||
*
|
||||
* The options dictionary takes:
|
||||
* * _initial_: the value for the key if not already present, defaults to 0.
|
||||
* * _expires_: overrides the default expiration (see `Client.create`) for this
|
||||
* particular key-value pair.
|
||||
*
|
||||
* The callback signature is:
|
||||
*
|
||||
* callback(err, success, value)
|
||||
* @param key
|
||||
* @param amount
|
||||
* @param options
|
||||
* @param callback
|
||||
*/
|
||||
decrement(
|
||||
key: string,
|
||||
amount: number,
|
||||
options: { initial?: number; expires?: number },
|
||||
callback: (
|
||||
err?: Error | null,
|
||||
success?: boolean,
|
||||
value?: number
|
||||
) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* APPEND
|
||||
*
|
||||
* Append the given _value_ to the value associated with the given _key_ in
|
||||
* memcache. The operation only succeeds if the key is already present. The
|
||||
* callback signature is:
|
||||
*
|
||||
* callback(err, success)
|
||||
* @param key
|
||||
* @param value
|
||||
* @param callback
|
||||
*/
|
||||
append(
|
||||
key: string,
|
||||
value: string | Buffer,
|
||||
callback: (err?: Error | null, success?: boolean) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* PREPEND
|
||||
*
|
||||
* Prepend the given _value_ to the value associated with the given _key_ in
|
||||
* memcache. The operation only succeeds if the key is already present. The
|
||||
* callback signature is:
|
||||
*
|
||||
* callback(err, success)
|
||||
* @param key
|
||||
* @param value
|
||||
* @param callback
|
||||
*/
|
||||
prepend(
|
||||
key: string,
|
||||
value: string | Buffer,
|
||||
callback: (err?: Error | null, success?: boolean) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* TOUCH
|
||||
*
|
||||
* Touch sets an expiration value, given by _expires_, on the given _key_ in
|
||||
* memcache. The operation only succeeds if the key is already present. The
|
||||
* callback signature is:
|
||||
*
|
||||
* callback(err, success)
|
||||
* @param key
|
||||
* @param expires
|
||||
* @param callback
|
||||
*/
|
||||
touch(
|
||||
key: string,
|
||||
expires: number,
|
||||
callback: (err?: Error | null, success?: boolean) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* FLUSH
|
||||
*
|
||||
* Flushes the cache on each connected server. The callback signature is:
|
||||
*
|
||||
* callback(lastErr, results)
|
||||
*
|
||||
* where _lastErr_ is the last error encountered (or null, in the common case
|
||||
* of no errors). _results_ is a dictionary mapping `"hostname:port"` to either
|
||||
* `true` (if the operation was successful), or an error.
|
||||
* @param callback
|
||||
*/
|
||||
flush(
|
||||
callback: (
|
||||
err?: Error | null,
|
||||
results?: Record<string, boolean>
|
||||
) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* STATS_WITH_KEY
|
||||
*
|
||||
* Sends a memcache stats command with a key to each connected server. The
|
||||
* callback is invoked **ONCE PER SERVER** and has the signature:
|
||||
*
|
||||
* callback(err, server, stats)
|
||||
*
|
||||
* _server_ is the `"hostname:port"` of the server, and _stats_ is a dictionary
|
||||
* mapping the stat name to the value of the statistic as a string.
|
||||
* @param key
|
||||
* @param callback
|
||||
*/
|
||||
statsWithKey(
|
||||
key: string,
|
||||
callback: (
|
||||
err?: Error | null,
|
||||
server?: string,
|
||||
stats?: Record<string, string>
|
||||
) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* RESET_STATS
|
||||
*
|
||||
* Reset the statistics each server is keeping back to zero. This doesn't clear
|
||||
* stats such as item count, but temporary stats such as total number of
|
||||
* connections over time.
|
||||
*
|
||||
* The callback is invoked **ONCE PER SERVER** and has the signature:
|
||||
*
|
||||
* callback(err, server)
|
||||
*
|
||||
* _server_ is the `"hostname:port"` of the server.
|
||||
* @param callback
|
||||
*/
|
||||
resetStats(callback: (err?: Error | null, server?: string) => void): void;
|
||||
|
||||
/**
|
||||
* QUIT
|
||||
*
|
||||
* Closes the connection to each server, notifying them of this intention. Note
|
||||
* that quit can race against already outstanding requests when those requests
|
||||
* fail and are retried, leading to the quit command winning and closing the
|
||||
* connection before the retries complete.
|
||||
*/
|
||||
quit(): void;
|
||||
|
||||
/**
|
||||
* CLOSE
|
||||
*
|
||||
* Closes (abruptly) connections to all the servers.
|
||||
*/
|
||||
close(): void;
|
||||
|
||||
/**
|
||||
* Perform a generic single response operation (get, set etc) on a server
|
||||
* serv: the server to perform the operation on
|
||||
* request: a buffer containing the request
|
||||
* seq: the sequence number of the operation. It is used to pin the callbacks
|
||||
* to a specific operation and should never change during a `perform`.
|
||||
* callback: a callback invoked when a response is received or the request
|
||||
* fails
|
||||
* retries: number of times to retry request on failure
|
||||
* @param key
|
||||
* @param request
|
||||
* @param seq
|
||||
* @param callback
|
||||
* @param retries
|
||||
*/
|
||||
perform(
|
||||
key: string,
|
||||
request: Buffer,
|
||||
seq: number,
|
||||
callback: () => void,
|
||||
retries: number
|
||||
): void;
|
||||
}
|
||||
10
types/memjs/memjs-tests.ts
Normal file
10
types/memjs/memjs-tests.ts
Normal file
@@ -0,0 +1,10 @@
|
||||
import * as memjs from "memjs";
|
||||
|
||||
const client = memjs.Client.create();
|
||||
|
||||
client.set("hello", "world", { expires: 600 }, (err, val) => {
|
||||
console.log(err, val);
|
||||
});
|
||||
client.get("hello", (err, val) => {
|
||||
console.log(err, val);
|
||||
});
|
||||
23
types/memjs/tsconfig.json
Normal file
23
types/memjs/tsconfig.json
Normal file
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": [
|
||||
"es6"
|
||||
],
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictNullChecks": true,
|
||||
"strictFunctionTypes": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": [
|
||||
"../"
|
||||
],
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"memjs-tests.ts"
|
||||
]
|
||||
}
|
||||
1
types/memjs/tslint.json
Normal file
1
types/memjs/tslint.json
Normal file
@@ -0,0 +1 @@
|
||||
{ "extends": "dtslint/dt.json" }
|
||||
Reference in New Issue
Block a user